vp_data_set

From Virtual Paradise Wiki
Revision as of 20:30, 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_data_set(instance, attr, length, data);

Set 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 set value of (defined in VP.h)
int
length
Length of data
const char*
data
Data 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

Behavior

There is no special behavior for this method

Examples

char data[1024];

memset(data, 1, sizeof(data));

vp_data_set(sdk, VP_OBJECT_DATA, sizeof(data), data);

See also