vp_string_get

From Virtual Paradise Wiki
Revision as of 19:06, 12 December 2016 by Sleepy E (talk | contribs) (Basic layout)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Method call snippet vp_string_get(instance, attr, value);

Retrieve 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
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 value is not modified.

Examples

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

See also