API System.GetHandleWord: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
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 | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:System | |||
::GetHandleWord | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|HANDLE]] Handle'' | ''[[Variable types|HANDLE]] Handle'' | ||
:The handle of an object created with CreateHandle() | :The handle of an object created with CreateHandle() | ||
| Line 10: | Line 16: | ||
:An index into the custom handles list of private words | :An index into the custom handles list of private words | ||
==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 | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Declare a variable 'result' of type ULONG | * Declare a variable 'result' of type ULONG | ||
* Add to a calculation icon: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.GetHandleWord(handle, index)</pre> | ||
Revision as of 21:14, 11 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
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)