vp_data

From Virtual Paradise Wiki
Revision as of 19:52, 12 December 2016 by Sleepy E (talk | contribs)
Jump to navigation Jump to search
Method call snippet vp_data(instance, attr, length);

Return the value of a data 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_data_attribute_t
attr
Attribute to return value of (defined in VP.h)
int*
length
Returns length of the data

Returns

const char*

Behavior

If the data attribute has not been set, then NULL will be returned and length is set to 0. If an invalid value is passed for attr, then NULL will be returned and length will not be set.

Caveats

This returns a pointer to binary data. Not a null-terminated string.

Examples

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

See also