API System.GetHandleWord: Difference between revisions
XML import API changes |
XML Import to change Variable types into Variable Types |
||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
[[Variable | [[Variable Types|HANDLE]] ''Handle'' | ||
:The handle of an object created with CreateHandle() | :The handle of an object created with CreateHandle() | ||
[[Variable | [[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== | ||
[[Variable | [[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 11:09, 10 June 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
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