Template:Sdk method page: Difference between revisions
Jump to navigation
Jump to search
Roy Curtis (talk | contribs) m shorterned RC |
Roy Curtis (talk | contribs) params higher priorty; shrunk code header text; added default VPInstance attr |
||
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''' | <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> | <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=" | <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> | ||
---- | |||
{{{2}}}__NOTOC__ | {{{2}}}__NOTOC__ | ||
== | == Parameters & attributes ==__NOEDITSECTION__ | ||
These are the parameters that this method requires: | |||
{{sdk parameter table|{{#if:{{{noinstanceparam}}}|{{sdk parameter row|VPInstance|instance|Pointer to the instance this method call is intended for}}|}}{{{parameters|}}}}} | |||
{{#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}}} |:''Nothing is returned by this method''}} | {{#if: {{{returns|}}} | {{{returns}}} |:''Nothing is returned by this method''}} | ||
Line 24: | Line 27: | ||
|param= | |param= | ||
|paramex= | |paramex= | ||
|parameters={{sdk parameter row|type|name|description}} | |||
|attributes={{sdk attribute row|type|name|description}} | |attributes={{sdk attribute row|type|name|description}} | ||
|returns= | |returns= | ||
|behavior= | |behavior= |
Revision as of 13:09, 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
- Nothing is returned by this method
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= }}