API Console.AddMemory: Difference between revisions
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 Console|Console]] | ====Class hierarchy==== | ||
[[API Console|Console]] | |||
:[[API Console|AddMemory]] | :[[API Console|AddMemory]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==Parameters== | ||
[[Variable types|STRING]] ''Name'' | |||
:The name to appear as the consoles title | :The name to appear as the consoles title | ||
[[Variable types|ULONG]] ''Bytes'' | |||
:The number of bytes to add to the buffer | :The number of bytes to add to the buffer | ||
[[Variable types|ULONG]] ''BpL'' | |||
:The number of bytes per line to display | :The number of bytes per line to display | ||
:''The default value for this parameter is: '''''16''' | :''The default value for this parameter is: '''''16''' | ||
[[Variable types|BYTE]] ''Init'' | |||
:The value to initialise each byte of memory to | :The value to initialise each byte of memory to | ||
:''The default value for this parameter is: '''''0''' | :''The default value for this parameter is: '''''0''' | ||
[[Variable types|BOOL]] ''UserWrite'' | |||
:Set true to allow amending of the data from the User | :Set true to allow amending of the data from the User | ||
| Line 29: | Line 30: | ||
[[Variable types|HANDLE]] | [[Variable types|HANDLE]] | ||
No additional information | ''<span style="color:red;">No additional information</span>'' | ||
==Detailed description== | ==Detailed description== | ||
''No additional information'' | ''<span style="color:red;">No additional information</span>'' | ||
==Examples== | ==Examples== | ||
| Line 38: | Line 42: | ||
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Console.AddMemory("name", bytes, bpl, init, false)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Console.AddMemory("name", bytes, bpl, init, false)</pre> | ||
''<span style="color:red;">No additional information</span>'' | |||
Revision as of 22:10, 11 May 2013
<sidebar>API contents</sidebar> Adds a window to the list of consoles available
Parameters
STRING Name
- The name to appear as the consoles title
ULONG Bytes
- The number of bytes to add to the buffer
ULONG BpL
- The number of bytes per line to display
- The default value for this parameter is: 16
BYTE Init
- The value to initialise each byte of memory to
- The default value for this parameter is: 0
BOOL UserWrite
- Set true to allow amending of the data from the User
Return value
No additional information
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type HANDLE
- Add to a calculation icon:
result = ::Console.AddMemory("name", bytes, bpl, init, false)
No additional information