Template:Sdk method page: Difference between revisions

Revision as of 17:45, 17 December 2016

Method call snippet vp_unknown(instance);

{{{2}}}

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=
|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 8: / Line 8: @@
 -->{{#if: {{{attributes|}}} |== Used attributes ==__NOEDITSECTION__
 This method uses data set in these attributes when called:
-{{sdk attribute param table|{{{attributes}}}}}
+{{sdk attribute table|{{{attributes}}}}}
 |}}
 == Returns ==__NOEDITSECTION__
@@ Line 14: / Line 14: @@
 {{sdk return code table|{{{returncodes|}}}}}
 {{#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__
 {{#if: {{{behavior|}}} | {{{behavior}}} |:''There is no special behavior for this method''}}