vp_init

From Virtual Paradise Wiki
Revision as of 16:21, 28 September 2013 by Roy Curtis (talk | contribs) (fix rc)
Jump to navigation Jump to search
Method call snippet vp_init(VP_BUILD);

Initializes the Virtual Paradise SDK, which is required before calling any other method of the SDK.

Parameters

These are the parameters that this method requires:

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

Returns

This method returns a return code integer, which indicates whether the call was successful or errored for any reason:

Return code Cause
VP_RC_SUCCESS Successful call (for methods that have a registered callback, it only means the request has been sent)
VP_RC_VERSION_MISMATCH VP.h and the SDK library are from different builds

Behavior

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.

Examples

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

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

</C>