Template:Sdk method page: Difference between revisions

Revision as of 16:10, 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)

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 14: / Line 14: @@
 == Returns ==__NOEDITSECTION__
 {{{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}}}}}
+{{sdk return code table|{{{returncodes|}}}}}
 {{#if: {{{returnattributes|}}} |Upon a successful call, this method sets data in the following attributes:
 {{sdk attribute table|{{{returnattributes}}}}} |}} }}}