Vp init: Difference between revisions
Jump to navigation
Jump to search
(+cat Category: SDK) |
mNo edit summary |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{sdk method page|init|Check if the version of the VPSDK used to build the application matches the version that is currently loaded. | |||
|customparam={{sdk parameter|int|version}} | |||
= | |customparamex=VPSDK_VERSION | ||
|noinstanceparam= | |||
|parameters= | |||
{{sdk parameter row|int|version|{{code|VPSDK_VERSION}} in VP.h defines the version of the SDK library}} | |||
|behavior= | |||
There is no longer a requirement to call this function. It is used to check if the version used to build the application is compatible with the version used at runtime. | |||
|returncodes= | |||
{{sdk return code row|version_mismatch|VP.h and the SDK library are from different builds}} | |||
|examples= | |||
<syntaxhighlight lang="c"> | |||
int rc; | int rc; | ||
if (rc = vp_init(VPSDK_VERSION)) | |||
printf("Incorrect VPSDK.dll version\n"); | |||
</syntaxhighlight> | |||
|seealso= | |||
* {{sdk method|create}} | |||
}} | |||
Latest revision as of 19:14, 1 August 2018
Method call snippet
vp_init(VPSDK_VERSION);Check if the version of the VPSDK used to build the application matches the version that is currently loaded.
Parameters
These are the parameters that this method requires:
| Parameter | Usage |
|---|---|
int version |
VPSDK_VERSION in VP.h defines the version 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
There is no longer a requirement to call this function. It is used to check if the version used to build the application is compatible with the version used at runtime.
Examples
int rc;
if (rc = vp_init(VPSDK_VERSION))
printf("Incorrect VPSDK.dll version\n");