Vp init: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
Oliver (talk | contribs)
m Fixed links for SDK reason codes
Oliver (talk | contribs)
Moved extra description to Notes.
Line 2: Line 2:


== Description ==
== 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.
Initializes the VP API.


== Callback ==
== Callback ==
None
None
== Notes ==
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.


== Arguments ==
== Arguments ==

Revision as of 14:28, 17 June 2012

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

Description

Initializes the VP API.

Callback

None

Notes

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.

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>