Vp init: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
(More info)
m (Fixed links for SDK reason codes)
Line 11: Line 11:


== Return values ==
== Return values ==
;[[VP_RC_SUCCESS]]
;[[SDK Reason Codes#VP_RC_SUCCESS|VP_RC_SUCCESS]]
;[[VP_RC_VERSION_MISMATCH]]:VP.h and the SDK library are from different builds.
;[[SDK Reason Codes#VP_RC_VERSION_MISMATCH|VP_RC_VERSION_MISMATCH]]:VP.h and the SDK library are from different builds.


== Example ==
== Example ==

Revision as of 14:05, 17 June 2012

<C>int vp_init(int version)</C>

Description

Initializes the VP API, this only has to be called once for every application. It is used to check if the version used to build the application is compatible with the version used at runtime.

Callback

None

Arguments

version
VP_BUILD in VP.h defines the build of the SDK library.

Return values

VP_RC_SUCCESS
VP_RC_VERSION_MISMATCH
VP.h and the SDK library are from different builds.

Example

<C> int rc; if(rc = vp_init(VP_BUILD))

   printf("Error initializing VP API(reason %d)\n", rc);

</C>