Difference between revisions of "API System.GetHandleWord"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Gets a general-purpose word set by the owner of a custom handle | Gets a general-purpose word set by the owner of a custom handle | ||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] ''Handle'' |
:The handle of an object created with CreateHandle() | :The handle of an object created with CreateHandle() | ||
| − | [[Variable | + | [[Variable Types|ULONG]] ''Index'' |
:An index into the custom handles list of private words | :An index into the custom handles list of private words | ||
| + | |||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|ULONG]] |
Returns the general-purpose word set by the owner of a custom handle | Returns the general-purpose word set by the owner of a custom handle | ||
| + | |||
==Detailed description== | ==Detailed description== | ||
| Line 30: | Line 32: | ||
* 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 | + | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:58, 16 January 2014
<sidebar>API Contents</sidebar> Gets a general-purpose word set by the owner of a custom handle
Contents
Parameters
HANDLE Handle
- The handle of an object created with CreateHandle()
ULONG Index
- An index into the custom handles list of private words
Return value
Returns the general-purpose word set by the owner of a custom handle
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type ULONG
- Add to a calculation icon:
result = ::System.GetHandleWord(handle, index)
No additional examples
