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