Template:Sdk method page

From Virtual Paradise Wiki
Revision as of 14:58, 28 September 2013 by Roy Curtis (talk | contribs) (return code default param)
Jump to navigation Jump to search
Method call snippet vp_unknown( instance );
int RC vp_unknown(
VPInstance
instance
)

{{{2}}}

Parameters & attributes

These are the parameters that this method requires:

Parameter Usage
VPInstance
instance
Pointer to the instance this method call is intended for
No attributes are sent by this method

Returns

This method returns a return code integer, which indicates whether the call was successful or errored for a specific reason. A successful call will always return 0. See the return code for all possible codes.

Behavior

There is no special behavior for this method

Examples

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


Usage

{{sdk event page|Event name|Event description
|returntype=
|param=
|paramex=
|parameters={{sdk parameter row|type|name|description}}
|attributes={{sdk attribute row|type|name|description}}
|returns=
|behavior=
|caveats=
|examples=
|seealso=
}}