Vp string: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| 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= | ||
The value of the attribute. | |||
|behavior=If an invalid | |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= | ||
Latest revision as of 22:11, 13 December 2016
Method call snippet
vp_string(instance, attr);Return the value of a string attribute.
Parameters
These are the parameters that this method requires:
| Parameter | Usage |
|---|---|
VPInstance instance |
Pointer to the instance this method call is intended for |
vp_string_attribute_t attr |
Attribute to return value of (defined in VP.h) |
Returns
The value of the attribute.
Behavior
If an invalid identifier is passed for attr, then a pointer to "" (empty string) will be returned.
Caveats
There is no way to know if the call was unsuccessful, use vp_string_get() when this is required.
Examples
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);
//...
}