Vp string - Revision history

Sleepy E at 22:11, 13 December 2016

2016-12-13T22:11:53Z

← Older revision		Revision as of 22:11, 13 December 2016
Line 4:		Line 4:
	{{sdk parameter row\|vp_string_attribute_t\|attr\|Attribute to return value of (defined in VP.h)}}		{{sdk parameter row\|vp_string_attribute_t\|attr\|Attribute to return value of (defined in VP.h)}}
	\|returns=		\|returns=
	const char*		The value of the attribute.
	\|behavior=If an invalid ~~value~~ is passed for <i>attr</i>, then a pointer to "" (empty string) will be returned.		\|behavior=If an invalid identifier is passed for <i>attr</i>, then a pointer to "" (empty string) will be returned.
	\|caveats=There is no way to know if the call was unsuccessful, use {{sdk method\|string_get}} when this is required.		\|caveats=There is no way to know if the call was unsuccessful, use {{sdk method\|string_get}} when this is required.
	\|examples=		\|examples=

Sleepy E at 19:39, 12 December 2016

2016-12-12T19:39:02Z

← Older revision		Revision as of 19:39, 12 December 2016
Line 1:		Line 1:
	{{sdk method page\|string\|Return a ~~pointer to~~ string attribute.		{{sdk method page\|string\|Return the value of a string attribute.
	\|paramex=attr		\|paramex=attr
	\|parameters=		\|parameters=
	{{sdk parameter row\|vp_string_attribute_t\|attr\|Attribute to return value of}}		{{sdk parameter row\|vp_string_attribute_t\|attr\|Attribute to return value of (defined in VP.h)}}
	\|returns=		\|returns=
	const char*		const char*
	\|behavior=		\|behavior=If an invalid value is passed for <i>attr</i>, then a pointer to "" (empty string) will be returned.
	~~\|caveats~~=If an invalid value is passed for attr, then a pointer to "" will be returned.		\|caveats=There is no way to know if the call was unsuccessful, use {{sdk method\|string_get}} when this is required.
	\|examples=		\|examples=
			<syntaxhighlight lang="c">
			void handle_avatar_add(VPInstance sdk)
			{
			char msg[256];

			sprintf(msg, "Welcome %s to the world!", vp_string(sdk, VP_AVATAR_NAME));
			vp_say(sdk, msg);
			}

			int main(int argc, const char* argv[])
			{

			//...

			vp_event_set(sdk, VP_EVENT_AVATAR_ADD, handle_avatar_add);

			//...
			}
			</syntaxhighlight>
	\|seealso=		\|seealso=
	* {{sdk method\|string_get}}		* {{sdk method\|string_get}}
	* {{sdk method\|string_set}}		* {{sdk method\|string_set}}
	}}		}}

Sleepy E at 18:48, 12 December 2016

2016-12-12T18:48:58Z

← Older revision		Revision as of 18:48, 12 December 2016
Line 1:		Line 1:
	{{sdk method page\|string\|Return ~~the value of~~ a string attribute.		{{sdk method page\|string\|Return a pointer to string attribute.
	\|paramex=attr		\|paramex=attr
	\|parameters=		\|parameters=

Sleepy E at 18:41, 12 December 2016

2016-12-12T18:41:42Z

← Older revision		Revision as of 18:41, 12 December 2016
Line 1:		Line 1:
	{{sdk method page\|~~int~~\|Return the value of a string attribute.		{{sdk method page\|string\|Return the value of a string attribute.
	\|paramex=attr		\|paramex=attr
	\|parameters=		\|parameters=

Sleepy E: Basic layout

2016-12-12T18:40:14Z

Basic layout

New page

{{sdk method page|int|Return the value of a string attribute.
|paramex=attr
|parameters=
{{sdk parameter row|vp_string_attribute_t|attr|Attribute to return value of}}
|returns=
const char*
|behavior=
|caveats=If an invalid value is passed for attr, then a pointer to "" will be returned.
|examples=
|seealso=
* {{sdk method|string_get}}
* {{sdk method|string_set}}
}}