Difference between revisions of "API System.SetHandleWord"

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

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'

This call does not return a value

No additional information

Add to a calculation icon:

::System.SetHandleWord(handle, index, value)

No additional examples

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+<sidebar>API Contents</sidebar>
 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===
+==Parameters==
-''[[Variable types|HANDLE]] Handle''
+[[Variable Types|HANDLE]] ''Handle''
 :The handle of an object created with CreateHandle()
-''[[Variable types|ULONG]] Index''
+[[Variable Types|ULONG]] ''Index''
 :An index into the custom handles list of private words
-''[[Variable types|ULONG]] Value''
+[[Variable Types|ULONG]] ''Value''
 :The value to write to slot 'Index'
-===Return value===
+==Return value==
 ''This call does not return a value''
-===Detailed description===
-''No additional information''
-===Examples===
+==Detailed description==
-====Calling in a calculation====
+''<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>''