Difference between revisions of "API System.GetHandleWord"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import API changes)
Line 19: Line 19:
 
==Return value==
 
==Return value==
 
[[Variable types|ULONG]]
 
[[Variable types|ULONG]]
 +
 
Returns the general-purpose word set by the owner of a custom handle
 
Returns the general-purpose word set by the owner of a custom handle
  

Revision as of 13:17, 14 May 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 information