Template:Sdk method page: Difference between revisions
Jump to navigation
Jump to search
Roy Curtis (talk | contribs) m return code default param |
Roy Curtis (talk | contribs) m reword |
||
| Line 11: | Line 11: | ||
{{#if: {{{attributes|}}} | {{sdk attribute table|{{{attributes}}}}} |:''No attributes are sent by this method''}} | {{#if: {{{attributes|}}} | {{sdk attribute table|{{{attributes}}}}} |:''No attributes are sent by this method''}} | ||
== Returns ==__NOEDITSECTION__ | == Returns ==__NOEDITSECTION__ | ||
{{#if: {{{returns|}}} | {{{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 '''{{code|0}}'''. See | {{#if: {{{returns|}}} | {{{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 '''{{code|0}}'''. See [[Return code|this page]] for all possible codes.}} | ||
== Behavior ==__NOEDITSECTION__ | == Behavior ==__NOEDITSECTION__ | ||
{{#if: {{{behavior|}}} | {{{behavior}}} |:''There is no special behavior for this method''}} | {{#if: {{{behavior|}}} | {{{behavior}}} |:''There is no special behavior for this method''}} | ||
Revision as of 15:43, 28 September 2013
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 this page 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=
}}