Difference between revisions of "API System.GetHandleWord"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 15: Line 15:
 
[[Variable types|ULONG]] ''Index''
 
[[Variable types|ULONG]] ''Index''
 
:An index into the custom handles list of private words
 
:An index into the custom handles list of private words
 +
  
 
==Return value==
 
==Return value==
Line 20: Line 21:
  
 
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
 +
  
 
==Detailed description==
 
==Detailed description==

Revision as of 01:56, 12 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