Difference between revisions of "API System.GetHandleWord"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(XML import API auto-gen)
Line 1: Line 1:
 
wiki page name
 
wiki page name
==SystemGetHandleWord==
+
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
 
----
 
  
 
===Parameters===
 
===Parameters===
Line 21: Line 19:
  
 
===Examples===
 
===Examples===
====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: result = ::System.GetHandleWord(handle, index)

Revision as of 15:34, 10 May 2013

wiki page name 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)