Jump to content

API System.GetHandleWord: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML Import to change Variable types into Variable Types
JonnyW (talk | contribs)
XML import of updated API docs
Line 1: Line 1:
<sidebar>API contents</sidebar>
<sidebar>API contents</sidebar>
Gets a general-purpose word set by the owner of a custom handle
Gets a general-purpose word set by the owner of a custom handle
Line 32: Line 34:
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.GetHandleWord(handle, index)</pre>
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.GetHandleWord(handle, index)</pre>


''<span style="color:red;">No additional information</span>''
''<span style="color:red;">No additional examples</span>''

Revision as of 09:57, 17 June 2013


<sidebar>API contents</sidebar> Gets a general-purpose word set by the owner of a custom handle

Class hierarchy

System

GetHandleWord

Parameters

HANDLE Handle

The handle of an object created with CreateHandle()

ULONG Index

An index into the custom handles list of private words


Return value

ULONG

Returns the general-purpose word set by the owner of a custom handle


Detailed description

No additional information


Examples

Calling in a calculation

  • Declare a variable 'result' of type ULONG
  • Add to a calculation icon:
    result = ::System.GetHandleWord(handle, index)

No additional examples