vp_string_get

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

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)
char** value	Returns a pointer to the string

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

Behavior

If unsuccessful, then pointer is not set.

Examples

This method has no usage examples; please add at least one to this page

See also

• vp_string()
• vp_string_set()