vp_user_data_set

From Virtual Paradise Wiki
Jump to navigation Jump to search
Method call snippet vp_user_data_set(instance, data);

Sets a pointer to user-defined data for this instance.

Parameters

These are the parameters that this method requires:

Parameter Usage
VPInstance
instance
Pointer to the instance this method call is intended for
void*
data
The pointer to your user-defined data.

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)

Behavior

This pointer is not accessed in any way, allocating and freeing it is the responsibility of the application programmer.

Examples

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

See also