API System.GetHandleWord: Difference between revisions

Revision as of 11:42, 16 January 2023

	GetHandleWord
Gets a general-purpose word set by the owner of a custom handle
- HANDLE	Handle
The handle of an object created with CreateHandle()
- ULONG	Index
An index into the custom handles list of private words
- ULONG	Return

No additional information

Add to a calculation icon:

result = ::System.GetHandleWord(handle, index)

No additional examples

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Gets a general-purpose word set by the owner of a custom handle
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetHandleWord'''
-====Class hierarchy====
+|-
-[[API System|System]]
+| colspan="2" | Gets a general-purpose word set by the owner of a custom handle&nbsp;
-:[[API System|GetHandleWord]]
+|-
-</div>
+|-
-__TOC__
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Handle
-==Parameters==
+|-
-[[Variable Types|HANDLE]] ''Handle''
+| colspan="2" | The handle of an object created with CreateHandle()&nbsp;
-:The handle of an object created with CreateHandle()
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-[[Variable Types|ULONG]] ''Index''
+| width="90%" | Index
-:An index into the custom handles list of private words
+|-
+| colspan="2" | An index into the custom handles list of private words&nbsp;
+|-
-==Return value==
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
-[[Variable Types|ULONG]]
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-Returns the general-purpose word set by the owner of a custom handle