Template:Sdk method page: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
Sleepy E (talk | contribs)
No edit summary
Sleepy E (talk | contribs)
m Testing
Line 8: Line 8:
-->{{#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 ({{code|0}}) or errored for any of these reasons:
{{{returns|This method returns a [[return code]] integer, which indicates whether the call was successful ({{code|0}}) or errored for any of these reasons:

Revision as of 22:26, 31 July 2018

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