Vp string set

Method call snippet vp_string_set(instance, attr, value);

Set 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 set value of (defined in VP.h)
const char* str	Value to set

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_NO_SUCH_ATTRIBUTE	Invalid attribute
VP_RC_VP_RC_STRING_TOO_LONG	String is too long

Behavior

There is no special behavior for this method

Examples

vp_string_set(sdk, VP_URL, "http://www.virtualparadise.org");

See also

• vp_string()
• vp_string_get()