Template:Sdk method page: Difference between revisions
Jump to navigation
Jump to search
Roy Curtis (talk | contribs) m made parameters optional |
mNo edit summary |
||
(12 intermediate revisions by 2 users not shown) | |||
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> | ||
{{{2}}}__NOTOC__ | {{{2}}}__NOTOC__ | ||
== Parameters ==__NOEDITSECTION__ | |||
These are the parameters that this method requires: | 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}}|}} | {{sdk parameter table|{{#if:{{{noinstanceparam}}}|{{sdk parameter row|VPInstance|instance|Pointer to the instance this method call is intended for}}|}} | ||
{{{parameters|}}} | {{{parameters|}}}}} | ||
{{#if: {{{attributes|}}} |== Used attributes ==__NOEDITSECTION__ | {{#if: {{{attributes|}}} |== Used attributes ==__NOEDITSECTION__ | ||
This method uses data set in these attributes when called: | This method uses data set in these attributes when called: | ||
{{sdk attribute table|{{{attributes}}}}} | {{sdk attribute table|{{{attributes}}}}} |}} | ||
|}} | |||
== Returns ==__NOEDITSECTION__ | == Returns ==__NOEDITSECTION__ | ||
{{{returns|This method returns a [[return code]] integer, which indicates whether the call was successful | {{{returns|This method returns a [[return code]] integer, which indicates whether the call was successful or errored for any reason: | ||
{{sdk return code table|{{{returncodes|}}}}} | {{sdk return code table|{{{returncodes|}}}}} | ||
{{#if: {{{returnattributes|}}} | | {{#if: {{{returnattributes|}}} |The following attributes will be returned in {{Sdk callback|{{{1}}}}} if the operation was successful: | ||
{{sdk attribute table|{{{returnattributes}}}}} |}} }}} | {{sdk return attribute table|{{{returnattributes}}}}} |}} }}} | ||
== 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''}} |
Latest revision as of 22:00, 1 August 2018
Method call snippet
vp_unknown(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 or errored for any reason:
Return code | Cause |
---|---|
VP_RC_SUCCESS |
Successful call (for methods that have a registered callback, it only means the request has been sent) |
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= |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= }}