Jump to content

API System.GetHandleWord: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import API auto-gen
Admin (talk | contribs)
XML import of API auto-gen
Line 21: Line 21:
====Calling in a calculation====
====Calling in a calculation====
* Declare a variable 'result' of type ULONG
* Declare a variable 'result' of type ULONG
* Add to a calculation icon: result = ::System.GetHandleWord(handle, index)
* Add to a calculation icon: <pre class="brush:[C]">result = ::System.GetHandleWord(handle, index)</pre>

Revision as of 15:35, 10 May 2013

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


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)