Template:Sdk method page: Difference between revisions

Revision as of 14:58, 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 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=
}}

@@ Line 1: / Line 1: @@
 <div style="float: right; width: 400px; {{box-sizing}} {{bg linearfade|color={{{color|204,100%,90%}}}}}; padding: 32px 16px 16px 16px; border-radius: 0px 0px 16px 16px;">'''Method call snippet'''
 <code style="display: block; padding: 8px; margin: 8px 0px; border: 1px dashed hsl(204,100%,70%);">vp_{{lc:{{{1|unknown}}}}}({{{customparamex| instance{{#if:{{{paramex|}}}|, {{{paramex}}}|}} }}});</code></div>
-<div style="font-family: Courier, monospace;">'''{{color|hsl({{huebytype|{{{returntype|int}}}}},100%,40%)|{{{returntype|int <sup title="SDK reason code">[[Reason code|RC]]</sup>}}}}}''' vp_{{lc:{{{1|unknown}}}}}({{{customparam| {{sdk parameter|VPInstance|instance}}{{#if:{{{param|}}}|, {{{param}}}|}} }}})</div>
+<div style="font-family: Courier, monospace;">'''{{color|hsl({{huebytype|{{{returntype|int}}}}},100%,40%)|{{{returntype|int <sup title="SDK return code">[[Return code|RC]]</sup>}}}}}''' vp_{{lc:{{{1|unknown}}}}}({{{customparam| {{sdk parameter|VPInstance|instance}}{{#if:{{{param|}}}|, {{{param}}}|}} }}})</div>
 ----
 {{{2}}}__NOTOC__
@@ Line 11: / Line 11: @@
 {{#if: {{{attributes|}}} | {{sdk attribute table|{{{attributes}}}}} |:''No attributes are sent by this method''}}
 == Returns ==__NOEDITSECTION__
-{{#if: {{{returns|}}} | {{{returns}}} |:''Nothing is returned by this method''}}
+{{#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 the [[return code]] for all possible codes.}}
 == Behavior ==__NOEDITSECTION__
 {{#if: {{{behavior|}}} | {{{behavior}}} |:''There is no special behavior for this method''}}