Vp init: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
(Moved extra description to Notes.)
(Added headings. Pointless headings)
Line 12: Line 12:
== Arguments ==
== Arguments ==
;version:VP_BUILD in VP.h defines the build of the SDK library.
;version:VP_BUILD in VP.h defines the build of the SDK library.
== Argument attributes ==
None


== Return values ==
== Return values ==
;[[SDK Reason Codes#VP_RC_SUCCESS|VP_RC_SUCCESS]]
;[[SDK Reason Codes#VP_RC_SUCCESS|VP_RC_SUCCESS]]
;[[SDK Reason Codes#VP_RC_VERSION_MISMATCH|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.
== Returned attributes ==
None


== Example ==
== Example ==

Revision as of 14:40, 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.

Argument attributes

None

Return values

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

Returned attributes

None

Example

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

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

</C>