Difference between revisions of "API System.SetHandleWord"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API System|System]] | + | ====Class hierarchy==== |
| + | [[API System|System]] | ||
:[[API System|SetHandleWord]] | :[[API System|SetHandleWord]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==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' | ||
| Line 22: | Line 23: | ||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::System.SetHandleWord(handle, index, value)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::System.SetHandleWord(handle, index, value)</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional information</span>'' | ||
Revision as of 22:12, 11 May 2013
<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 information
