Jump to content

API System.SetHandleWord: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import
No edit summary
Line 1: Line 1:
<sidebar>API Contents</sidebar>
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Sets a general purpose word in the handle for use by its owner
|-
 
| 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;" | '''SetHandleWord'''
====Class hierarchy====
|-
[[API System|System]]
| colspan="2" | Sets a general purpose word in the handle for use by its owner&nbsp;
:[[API System|SetHandleWord]]
|-
</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;
[[Variable Types|ULONG]] ''Value''
|-
:The value to write to slot 'Index'
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 
| width="90%" | Value
 
|-
==Return value==
| colspan="2" | The value to write to slot 'Index'&nbsp;
''This call does not return a value''
|-
| 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''
|}





Revision as of 11:42, 16 January 2023

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

No additional information


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::System.SetHandleWord(handle, index, value)

No additional examples