API Console.AddMemory - Revision history

Wiki bot at 11:41, 16 January 2023

2023-01-16T11:41:48Z

JonnyW: XML import

2014-01-16T15:57:44Z

XML import

ReeceL: /* Flowchart example */

2013-09-20T13:38:08Z

Flowchart example

JonnyW: XML import of API documentation

2013-08-09T14:27:38Z

XML import of API documentation

JonnyW: XML Import to change Variable types into Variable Types

2013-06-10T11:08:53Z

XML Import to change Variable types into Variable Types

JonnyW at 09:39, 5 June 2013

2013-06-05T09:39:09Z

JonnyW at 09:37, 5 June 2013

2013-06-05T09:37:27Z

JonnyW at 09:36, 5 June 2013

2013-06-05T09:36:19Z

JonnyW at 09:36, 5 June 2013

2013-06-05T09:36:03Z

JonnyW: XML import API changes

2013-05-14T13:15:38Z

XML import API changes

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Adds a window to the list of consoles available
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AddMemory'''
-====Class hierarchy====
+|-
-[[API Console|Console]]
+| colspan="2" | Adds a window to the list of consoles available&nbsp;
-:[[API Console|AddMemory]]
+|-
-</div>
+|-
-__TOC__
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Name
-==Parameters==
+|-
-[[Variable Types|STRING]] ''Name''
+| colspan="2" | The name to appear as the consoles title&nbsp;
-:The name to appear as the consoles title
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-[[Variable Types|ULONG]] ''Bytes''
+| width="90%" | Bytes
-:The number of bytes to add to the buffer
+|-
+| colspan="2" | The number of bytes to add to the buffer&nbsp;
-[[Variable Types|ULONG]] ''BpL''
+|-
-:The number of bytes per line to display
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-:''The default value for this parameter is: '''''16'''
+| width="90%" | BpL
+|-
-[[Variable Types|BYTE]] ''Init''
+| colspan="2" | The number of bytes per line to display&nbsp;
-:The value to initialise each byte of memory to
+|-
-:''The default value for this parameter is: '''''0'''
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Init
-[[Variable Types|BOOL]] ''UserWrite''
+|-
-:Set true to allow amending of the data from the User
+| colspan="2" | The value to initialise each byte of memory to&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-==Return value==
+| width="90%" | UserWrite
-[[Variable Types|HANDLE]]
+|-
+| colspan="2" | Set true to allow amending of the data from the User&nbsp;
-A handle to the memory console that can be used to change its style and content.
+|-

@@ Line 1: / Line 1: @@
 <sidebar>API Contents</sidebar>
 Adds a window to the list of consoles available
@@ Line 52: / Line 50: @@
 ===Flowchart example===
-The example [[file:SIMAPI Console.fcfx]] illustrates basic creation of a console window.
+The example {{Fcfile|SIMAPI Console.fcfx|SIMAPI Console}} illustrates basic creation of a console window.

← Older revision		Revision as of 13:38, 20 September 2013
Line 52:		Line 52:

	===Flowchart example===		===Flowchart example===
−	The example [[file:SIMAPI Console.~~fcf~~]] illustrates basic creation of a console window.	+	The example [[file:SIMAPI Console.fcfx]] illustrates basic creation of a console window.

← Older revision		Revision as of 14:27, 9 August 2013
Line 1:		Line 1:
−	<sidebar>API ~~contents~~</sidebar>	+
		+
		+	<sidebar>API Contents</sidebar>
	Adds a window to the list of consoles available		Adds a window to the list of consoles available

@@ Line 10: / Line 10: @@
 ==Parameters==
-[[Variable types|STRING]] ''Name''
+[[Variable Types|STRING]] ''Name''
 :The name to appear as the consoles title
-[[Variable types|ULONG]] ''Bytes''
+[[Variable Types|ULONG]] ''Bytes''
 :The number of bytes to add to the buffer
-[[Variable types|ULONG]] ''BpL''
+[[Variable Types|ULONG]] ''BpL''
 :The number of bytes per line to display
 :''The default value for this parameter is: '''''16'''
-[[Variable types|BYTE]] ''Init''
+[[Variable Types|BYTE]] ''Init''
 :The value to initialise each byte of memory to
 :''The default value for this parameter is: '''''0'''
-[[Variable types|BOOL]] ''UserWrite''
+[[Variable Types|BOOL]] ''UserWrite''
 :Set true to allow amending of the data from the User
 ==Return value==
-[[Variable types|HANDLE]]
+[[Variable Types|HANDLE]]
 A handle to the memory console that can be used to change its style and content.

@@ Line 35: / Line 35: @@
 ==Detailed description==
-A memory console is a block of text suitable for use as a memory display, for example to display the contents of a disk or EEPROM.
+A memory console is a block of text suitable for use as a memory display, for example to display the contents of a disk or EEPROM. When text is added, this will always overwrite the existing memory so the text contents will remain the same size. This differs from the [[API Console.AddText|AddText]] call which has an unlimited size and operates in 'append' mode to add to the text.
 Once a handle is created it must be retained, as Flowcode will remove any handles from the system that are not referenced.
 The style and content of the console can be changed at any time. The only thing that is fixed is the ''type'' of console - a memory console always has a fixed size and a fixed number of characters per line.

← Older revision		Revision as of 09:36, 5 June 2013
Line 31:		Line 31:
	[[Variable types\|HANDLE]]		[[Variable types\|HANDLE]]

−	~~''<span~~ style~~="color:red;">No additional information</span>''~~	+	A handle to the text console that can be used to change its style and content.