Vp int get: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
Sleepy E (talk | contribs)
Basic layout
 
Sleepy E (talk | contribs)
mNo edit summary
Line 6: Line 6:
|returncodes=
|returncodes=
   {{sdk return code row|NO_SUCH_ATTRIBUTE  |Invalid attribute}}
   {{sdk return code row|NO_SUCH_ATTRIBUTE  |Invalid attribute}}
|behavior=If an invalid value is passed for attr, then value is not modified.
|behavior=If unsuccessful, then value is not modified.
|caveats=
|caveats=
|examples=
|examples=

Revision as of 19:04, 12 December 2016

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

Retrieve an integer 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_int_attribute_t
attr
Attribute to return
int*
value
Returns the value

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