Template:Sdk method page: Difference between revisions

Revision as of 16:04, 28 September 2013

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=
}}

@@ Line 4: / Line 4: @@
 ----
 {{{2}}}__NOTOC__
-== Parameters & attributes ==__NOEDITSECTION__
+== Parameters ==__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|}}} |== Used attributes ==__NOEDITSECTION__
-{{#if: {{{attributes|}}} | {{sdk attribute table|{{{attributes}}}}} |:''No attributes are sent by this method''}}
+This method uses data set in these attributes when called:
+{{sdk attribute table|{{{attributes}}}}}
+|}}
 == 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 [[Return code|this page]] for all possible codes.}}
+{{{returns|This method returns a [[return code]] integer, which indicates whether the call was successful ({{code|0}}) or errored for any of these reasons:
+{{sdk return code table|{{{returncodes}}}}}
+{{#if: {{{returnattributes|}}} |Upon a successful call, this method sets data in the following attributes:
+{{sdk attribute table|{{{returnattributes}}}}} |}} }}}
 == Behavior ==__NOEDITSECTION__
 {{#if: {{{behavior|}}} | {{{behavior}}} |:''There is no special behavior for this method''}}
@@ Line 28: / Line 33: @@
 |param=
 |paramex=
-|parameters={{sdk parameter row|type|name|description}}
+|parameters=
-|attributes={{sdk attribute row|type|name|description}}
+  {{sdk parameter row|type|name|description}}
-|returns=
+|attributes=
+  {{sdk attribute row|type|name|description}}
+|returncodes=
+  {{sdk return code row|name|cause}}
+|returnattributes=
+  {{sdk attribute row|type|name|description}}
 |behavior=
 |caveats=