API System.SetHandleWord: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	SetHandleWord
Sets a general purpose word in the handle for use by its owner
- HANDLE	Handle
The handle of an object created with CreateHandle()
- ULONG	Index
An index into the custom handles list of private words
- ULONG	Value
The value to write to slot 'Index'
- NONE	Return

Detailed description

Examples

Calling in a calculation

Add to a calculation icon:

::System.SetHandleWord(handle, index, value)

@@ Line 1: / Line 1: @@
-wiki page name
+{| class="mtx-class-macrotable wikitable"
-Sets a general purpose word in the handle for use by its owner
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''SetHandleWord'''
+|-
+| colspan="2" | Sets a general purpose word in the handle for use by its owner&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" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Value
+|-
+| colspan="2" | The value to write to slot 'Index'&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-===Parameters===
+==Detailed description==
-''[[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
-''[[Variable types|ULONG]] Value''
-:The value to write to slot 'Index'
-===Return value===
+==Examples==
-''This call does not return a value''
+===Calling in a calculation===
+* Add to a calculation icon: <pre class="brush:[cpp]">::System.SetHandleWord(handle, index, value)</pre>
-===Detailed description===
-''No additional information''
-===Examples===
-====Calling in a calculation====
-* Add to a calculation icon: ::System.SetHandleWord(handle, index, value)

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation