Difference between revisions of "API System.GetHandleWord"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(6 intermediate revisions by 2 users not shown)
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]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
 +
|}
  
−
<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
 
  
 +
==Detailed description==
  
−
==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 30: Line 30:
 
* 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>''
 

Latest revision as of 11:55, 16 January 2023

Fc9-comp-macro.png GetHandleWord
Gets a general-purpose word set by the owner of a custom handle 
Fc9-h32-icon.png - HANDLE Handle
The handle of an object created with CreateHandle() 
Fc9-u32-icon.png - ULONG Index
An index into the custom handles list of private words 
Fc9-u32-icon.png - 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)
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=API_System.GetHandleWord&oldid=30336"