Vp init - Revision history

Sleepy E at 19:14, 1 August 2018

2018-08-01T19:14:05Z

← Older revision		Revision as of 19:14, 1 August 2018
Line 14:		Line 14:

	if (rc = vp_init(VPSDK_VERSION))		if (rc = vp_init(VPSDK_VERSION))
	printf("~~Error initializing VP API (reason %d)~~\n"~~, rc~~);		printf("Incorrect VPSDK.dll version\n");
	</syntaxhighlight>		</syntaxhighlight>
	\|seealso=		\|seealso=
	* {{sdk method\|create}}		* {{sdk method\|create}}
	}}		}}

Sleepy E at 19:11, 16 December 2016

2016-12-16T19:11:01Z

← Older revision		Revision as of 19:11, 16 December 2016
Line 6:		Line 6:
	{{sdk parameter row\|int\|version\|{{code\|VPSDK_VERSION}} in VP.h defines the version of the SDK library}}		{{sdk parameter row\|int\|version\|{{code\|VPSDK_VERSION}} in VP.h defines the version of the SDK library}}
	\|behavior=		\|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.		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=		\|returncodes=
	{{sdk return code row\|version_mismatch\|VP.h and the SDK library are from different builds}}		{{sdk return code row\|version_mismatch\|VP.h and the SDK library are from different builds}}
Line 12:		Line 12:
	<syntaxhighlight lang="c">		<syntaxhighlight lang="c">
	int rc;		int rc;
	if(rc = vp_init(VPSDK_VERSION))
			if (rc = vp_init(VPSDK_VERSION))
	printf("Error initializing VP API (reason %d)\n", rc);		printf("Error initializing VP API (reason %d)\n", rc);
	</syntaxhighlight>		</syntaxhighlight>

Sleepy E: No longer required, VP_BUILD => VPSDK_VERSION

2016-12-16T19:05:31Z

No longer required, VP_BUILD => VPSDK_VERSION

← Older revision		Revision as of 19:05, 16 December 2016
Line 1:		Line 1:
	{{sdk method page\|init\|~~Initializes~~ the ~~Virtual Paradise SDK, which is required before calling any other method~~ of the ~~SDK~~.		{{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}}		\|customparam={{sdk parameter\|int\|version}}
	\|customparamex=~~VP_BUILD~~		\|customparamex=VPSDK_VERSION
	\|noinstanceparam=		\|noinstanceparam=
	\|parameters=		\|parameters=
	{{sdk parameter row\|int\|version\|{{code\|~~VP_BUILD~~}} in VP.h defines the ~~build~~ of the SDK library}}		{{sdk parameter row\|int\|version\|{{code\|VPSDK_VERSION}} in VP.h defines the version of the SDK library}}
	\|behavior=		\|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.		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.
Line 12:		Line 12:
	<syntaxhighlight lang="c">		<syntaxhighlight lang="c">
	int rc;		int rc;
	if(rc = vp_init(~~VP_BUILD~~))		if(rc = vp_init(VPSDK_VERSION))
	printf("Error initializing VP API (reason %d)\n", rc);		printf("Error initializing VP API (reason %d)\n", rc);
	</syntaxhighlight>		</syntaxhighlight>

Edwin: updated syntax highlighting tags

2015-02-06T18:06:28Z

updated syntax highlighting tags

← Older revision		Revision as of 18:06, 6 February 2015
Line 10:		Line 10:
	{{sdk return code row\|version_mismatch\|VP.h and the SDK library are from different builds}}		{{sdk return code row\|version_mismatch\|VP.h and the SDK library are from different builds}}
	\|examples=		\|examples=
	<C>		<syntaxhighlight lang="c">
	int rc;		int rc;
	if(rc = vp_init(VP_BUILD))		if(rc = vp_init(VP_BUILD))
	printf("Error initializing VP API (reason %d)\n", rc);		printf("Error initializing VP API (reason %d)\n", rc);
	</C>		</syntaxhighlight>
	\|seealso=		\|seealso=
	* {{sdk method\|create}}		* {{sdk method\|create}}
	}}		}}

Roy Curtis: added seealso

2013-09-30T15:02:20Z

added seealso

← Older revision		Revision as of 15:02, 30 September 2013
Line 15:		Line 15:
	printf("Error initializing VP API (reason %d)\n", rc);		printf("Error initializing VP API (reason %d)\n", rc);
	</C>		</C>
			\|seealso=
			* {{sdk method\|create}}
	}}		}}

Roy Curtis: format

2013-09-28T16:33:29Z

format

← Older revision		Revision as of 16:33, 28 September 2013
Line 4:		Line 4:
	\|noinstanceparam=		\|noinstanceparam=
	\|parameters=		\|parameters=
	{{sdk parameter row\|int\|version\|VP_BUILD in VP.h defines the build of the SDK library}}		{{sdk parameter row\|int\|version\|{{code\|VP_BUILD}} in VP.h defines the build of the SDK library}}
	\|behavior=		\|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.		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.

Roy Curtis: fix rc

2013-09-28T16:21:31Z

fix rc

← Older revision		Revision as of 16:21, 28 September 2013
Line 8:		Line 8:
	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.		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.
	\|returncodes=		\|returncodes=
	~~{{sdk return code row}}~~
	{{sdk return code row\|version_mismatch\|VP.h and the SDK library are from different builds}}		{{sdk return code row\|version_mismatch\|VP.h and the SDK library are from different builds}}
	\|examples=		\|examples=

Roy Curtis: test commit; new method page

2013-09-28T15:54:44Z

test commit; new method page

← Older revision		Revision as of 15:54, 28 September 2013
Line 1:		Line 1:
	~~<C>int vp_init(~~int version~~)</C>~~		{{sdk method page\|init\|Initializes the Virtual Paradise SDK, which is required before calling any other method of the SDK.
			\|customparam={{sdk parameter\|int\|version}}
	=~~= Description =~~=		\|customparamex=VP_BUILD
	~~Initializes the~~ VP ~~API~~.		\|noinstanceparam=
			\|parameters=
	~~== Callback ==~~		{{sdk parameter row\|int\|version\|VP_BUILD in VP.h defines the build of the SDK library}}
	~~None~~		\|behavior=

	~~== 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.		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.
			\|returncodes=
	~~== Arguments~~ ==		{{sdk return code row}}
	~~;version:VP_BUILD in VP.h defines the build of the SDK library.~~		{{sdk return code row\|version_mismatch\|VP.h and the SDK library are from different builds}}
			\|examples=
	~~== Argument attributes ==~~
	~~None~~

	~~== Return values ==~~
	~~;[[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.

	~~== Returned attributes ==~~
	~~None~~

	~~== Example =~~=
	<C>		<C>
	int rc;		int rc;
	if(rc = vp_init(VP_BUILD))		if(rc = vp_init(VP_BUILD))
	printf("Error initializing VP API(reason %d)\n", rc);		printf("Error initializing VP API (reason %d)\n", rc);
	</C>		</C>
			}}
	~~[[Category: SDK]]~~

Legion: +cat Category: SDK

2012-07-29T20:14:26Z

+cat Category: SDK

← Older revision		Revision as of 20:14, 29 July 2012
Line 29:		Line 29:
	printf("Error initializing VP API(reason %d)\n", rc);		printf("Error initializing VP API(reason %d)\n", rc);
	</C>		</C>

			[[Category: SDK]]

Oliver: Added headings. Pointless headings

2012-06-17T14:40:06Z

Added headings. Pointless headings

← Older revision		Revision as of 14:40, 17 June 2012
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 ==