API Console.AddMemory: Difference between revisions
Appearance
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Adds a window to the list of consoles available | Adds a window to the list of consoles available | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:Console | |||
::AddMemory | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|STRING]] Name'' | ''[[Variable types|STRING]] Name'' | ||
:The name to appear as the consoles title | :The name to appear as the consoles title | ||
| Line 21: | Line 27: | ||
:Set true to allow amending of the data from the User | :Set true to allow amending of the data from the User | ||
==Return value== | |||
[[Variable types|HANDLE]] | [[Variable types|HANDLE]] | ||
No additional information | No additional information | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
* Add to a calculation icon: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Console.AddMemory("name", bytes, bpl, init, false)</pre> | ||
Revision as of 16:57, 11 May 2013
<sidebar>API contents</sidebar> Adds a window to the list of consoles available
Class hierarchy
- Console
- AddMemory
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)