API System.GetHandleWord: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	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

Detailed description

Examples

Calling in a calculation

Declare a variable 'result' of type ULONG

Add to a calculation icon:

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

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetHandleWord'''
+|-
+| colspan="2" | Gets a general-purpose word set by the owner of a custom handle&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Handle
+|-
+| colspan="2" | The handle of an object created with CreateHandle()&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Index
+|-
+| colspan="2" | An index into the custom handles list of private words&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<sidebar>API Contents</sidebar>
+==Detailed description==
-Gets a general-purpose word set by the owner of a custom handle
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API System|System]]
-:[[API System|GetHandleWord]]
-</div>
-__TOC__
-==Parameters==
-[[Variable Types|HANDLE]] ''Handle''
-:The handle of an object created with CreateHandle()
-[[Variable Types|ULONG]] ''Index''
-:An index into the custom handles list of private words
-==Return value==
-[[Variable Types|ULONG]]
-Returns the general-purpose word set by the owner of a custom handle
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 33: / Line 30: @@
 * Declare a variable 'result' of type ULONG
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.GetHandleWord(handle, index)</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation