Difference between revisions of "API System.SetHandleWord"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
(10 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Sets a general purpose word in the handle for use by its owner | Sets a general purpose word in the handle for use by its owner | ||
+ | <div style="width:25%; float:right" class="toc"> | ||
+ | ====Class hierarchy==== | ||
+ | [[API System|System]] | ||
+ | :[[API System|SetHandleWord]] | ||
+ | </div> | ||
+ | __TOC__ | ||
− | + | ==Parameters== | |
− | + | [[Variable Types|HANDLE]] ''Handle'' | |
:The handle of an object created with CreateHandle() | :The handle of an object created with CreateHandle() | ||
− | + | [[Variable Types|ULONG]] ''Index'' | |
:An index into the custom handles list of private words | :An index into the custom handles list of private words | ||
− | + | [[Variable Types|ULONG]] ''Value'' | |
:The value to write to slot 'Index' | :The value to write to slot 'Index' | ||
− | + | ||
+ | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
− | |||
− | |||
− | ===Examples | + | ==Detailed description== |
− | + | ''<span style="color:red;">No additional information</span>'' | |
− | * Add to a calculation icon: ::System.SetHandleWord(handle, index, value) | + | |
+ | |||
+ | ==Examples== | ||
+ | ===Calling in a calculation=== | ||
+ | * Add to a calculation icon: <pre class="brush:[cpp]">::System.SetHandleWord(handle, index, value)</pre> | ||
+ | |||
+ | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:58, 16 January 2014
<sidebar>API Contents</sidebar> Sets a general purpose word in the handle for use by its owner
Contents
Parameters
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'
Return value
This call does not return a value
Detailed description
No additional information
Examples
Calling in a calculation
- Add to a calculation icon:
::System.SetHandleWord(handle, index, value)
No additional examples