Template:Sdk method page

From Virtual Paradise Wiki
Revision as of 16:04, 28 September 2013 by Roy Curtis (talk | contribs) (added return code and return attributes tables)
Jump to navigation Jump to search
Method call snippet vp_unknown( instance );
int RC vp_unknown(
VPInstance
instance
)

{{{2}}}

Parameters

These are the parameters that this method requires:

Parameter Usage
VPInstance
instance
Pointer to the instance this method call is intended for

Returns

This method returns a return code integer, which indicates whether the call was successful (0) or errored for any of these reasons:

Return code Cause
VP_RC_SUCCESS Successful call (for methods that have a registered callback, it only means the request has been sent)

{{{returncodes}}}

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}}
|returncodes=
  {{sdk return code row|name|cause}}
|returnattributes=
  {{sdk attribute row|type|name|description}}
|behavior=
|caveats=
|examples=
|seealso=
}}