API System.SetHandleWord: Difference between revisions
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
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=== | |||
:System | |||
::SetHandleWord | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|HANDLE]] Handle'' | ''[[Variable types|HANDLE]] Handle'' | ||
:The handle of an object created with CreateHandle() | :The handle of an object created with CreateHandle() | ||
| Line 13: | Line 19: | ||
: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'' | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Add to a calculation icon: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">::System.SetHandleWord(handle, index, value)</pre> | ||
Revision as of 21:14, 11 May 2013
<sidebar>API contents</sidebar> Sets a general purpose word in the handle for use by its owner
Class hierarchy
- System
- SetHandleWord
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)