Template:Sdk callback page: Difference between revisions

From Virtual Paradise Wiki
Jump to navigation Jump to search
Sleepy E (talk | contribs)
Added callback page template
 
Sleepy E (talk | contribs)
mNo edit summary
Line 5: Line 5:
{{{2}}}__NOTOC__
{{{2}}}__NOTOC__
== Reason code ==__NOEDITSECTION__
== Reason code ==__NOEDITSECTION__
{{{reasoncodes|This callback is passed a [[return code]] integer, which indicates whether the request was successful ({{code|0}}) or errored for any of these reasons:
{{{returns|This callback is passed a [[return code]] integer, which indicates whether the request was successful ({{code|0}}) or errored for any of these reasons:
{{sdk return code table|{{{reasoncodes|}}}}}
{{sdk return code table|{{{reasoncodes|}}}}}
== Return attributes ==__NOEDITSECTION__
== Return attributes ==__NOEDITSECTION__

Revision as of 21:02, 30 July 2018

Callback set and handler snippet

vp_callback_set(instance, VP_CALLBACK_UNKNOWN, callback_unknown);

void callback_unknown(VPInstance instance, int reason_code) { }

{{{2}}}

Reason code

{{{returns|This callback is passed a return code integer, which indicates whether the request 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)

Return attributes

No attributes are returned in this callback

Behavior

There is no special behavior for this callback

Examples

This callback has no usage examples; please add at least one to this page


Usage

{{sdk callback page|Callback name|Callback description
|reasoncodes=
  {{sdk return code row|name|cause}}
|returnattributes=
  {{sdk attribute row|type|name|description}}
|behavior=
|caveats=
|examples=
|seealso=
}}