Difference between revisions of "Unit Console"

From Ultibo.org
Jump to: navigation, search
(Replaced content with "Return to Unit Reference === Description === ---- ''To be documented'' === Constants === ---- ''To be documented'' === Type definitions === ----...")
Line 25: Line 25:
 
----
 
----
  
 +
''To be documented''
  
−
'''Initialization functions'''
 
  
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleInit;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
 
−
'''Console functions'''
 
−
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceOpen(Console:PConsoleDevice):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceClose(Console:PConsoleDevice):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceClear(Console:PConsoleDevice;Color:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceClose(Console:PConsoleDevice):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceScroll(Console:PConsoleDevice;X1,Y1,X2,Y2,Count,Direction:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceDrawBox(Console:PConsoleDevice;X1,Y1,X2,Y2,Color,Width:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceDrawLine(Console:PConsoleDevice;X1,Y1,X2,Y2,Color,Width:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceDrawChar(Console:PConsoleDevice;Handle:TFontHandle;Ch:Char;X,Y,Forecolor,Backcolor:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceDrawText(Console:PConsoleDevice;Handle:TFontHandle;const Text:String;X,Y,Forecolor,Backcolor,Len:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceDrawPixel(Console:PConsoleDevice;X,Y,Color:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceDrawBlock(Console:PConsoleDevice;X1,Y1,X2,Y2,Color:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceDrawImage(Console:PConsoleDevice;X,Y:LongWord;Buffer:Pointer;Width,Height,Format,Skip:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceDrawWindow(Console:PConsoleDevice;Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceGetPixel(Console:PConsoleDevice;X,Y:LongWord;var Color:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceGetImage(Console:PConsoleDevice;X,Y:LongWord;Buffer:Pointer;Width,Height,Format,Skip:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceCopyImage(Console:PConsoleDevice;const Source,Dest:TConsolePoint;Width,Height:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceGetPosition(Console:PConsoleDevice;Position:LongWord;var X1,Y1,X2,Y2:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceGetProperties(Console:PConsoleDevice;Properties:PConsoleProperties):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceCheckFlag(Console:PConsoleDevice;Flag:LongWord):Boolean;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceGetMode(Console:PConsoleDevice):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceGetState(Console:PConsoleDevice):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceCreate:PConsoleDevice;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Create a new Console entry
 
−
|-
 
−
! '''Return'''
 
−
| Pointer to new Console entry or nil if Console could not be created
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceCreateEx(Size:LongWord):PConsoleDevice;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Create a new Console entry
 
−
|-
 
−
! '''Size'''
 
−
| Size in bytes to allocate for new Console (Including the Console entry)
 
−
|-
 
−
! '''Return'''
 
−
| Pointer to new Console entry or nil if Console could not be created
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceDestroy(Console:PConsoleDevice):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Destroy an existing Console entry
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceRegister(Console:PConsoleDevice):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Register a new Console in the Console table
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceDeregister(Console:PConsoleDevice):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Deregister a Console from the Console table
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceFind(ConsoleId:LongWord):PConsoleDevice;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceFindByDevice(Device:PDevice):PConsoleDevice;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceFindByName(const Name:String):PConsoleDevice; inline;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceFindByDescription(const Description:String):PConsoleDevice; inline;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceEnumerate(Callback:TConsoleEnumerate;Data:Pointer):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleDeviceNotification(Console:PConsoleDevice;Callback:TConsoleNotification;Data:Pointer;Notification,Flags:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
 
−
'''Text console functions'''
 
−
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowCreate(Console:PConsoleDevice;Position:LongWord;Default:Boolean):TWindowHandle;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Create a new Console window
 
−
|-
 
−
! '''Console'''
 
−
| The console device to create the new window on
 
−
|-
 
−
! '''Position'''
 
−
| The console position to create the new window at (eg CONSOLE_POSITION_FULL)
 
−
|-
 
−
! '''Return'''
 
−
| Handle to new Console window or INVALID_HANDLE_VALUE if Console window could not be created
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowCreateEx(Console:PConsoleDevice;Font:TFontHandle;Size,State,Mode,Position:LongWord;Default:Boolean):TWindowHandle;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Create a new Console window
 
−
|-
 
−
! '''Console'''
 
−
| The console device to create the new window on
 
−
|-
 
−
! '''Font'''
 
−
| The handle of the default font for the new console window
 
−
|-
 
−
! '''Size'''
 
−
| The size in bytes to allocate for the new window entry (Defaults to SizeOf(TConsoleWindow))
 
−
|-
 
−
! '''State'''
 
−
| Handle to new Console window or INVALID_HANDLE_VALUE if Console window could not be created
 
−
|-
 
−
! '''Mode'''
 
−
| The mode of the new console window (Normally WINDOW_MODE_TEXT)
 
−
|-
 
−
! '''Position'''
 
−
| The console position to create the new window at (eg CONSOLE_POSITION_FULL)
 
−
|-
 
−
! '''Return'''
 
−
| Handle to new Console window or INVALID_HANDLE_VALUE if Console window could not be created
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowDestroy(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Close and Destroy an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to destroy
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowShow(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Make an existing console window visible and show it on screen
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to show
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowHide(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Make an existing console window invisible and hide it on screen
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to hide
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowFind(Console:PConsoleDevice;Position:LongWord):TWindowHandle;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Find an existing console window in the position specified
 
−
|-
 
−
! '''Console'''
 
−
| The console device to find the window on
 
−
|-
 
−
! '''Position'''
 
−
| The window position to find (eg CONSOLE_POSITION_FULL)
 
−
|-
 
−
! '''Return'''
 
−
| The handle of the existing window or INVALID_HANDLE_VALUE if not found
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowEnumerate(Console:PConsoleDevice;Callback:TConsoleWindowEnumerate;Data:Pointer):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Enumerate existing console windows on the specified console device
 
−
|-
 
−
! '''Console'''
 
−
| The console device to enumerate windows for
 
−
|-
 
−
! '''Callback'''
 
−
| The function to call for each window enumerated
 
−
|-
 
−
! '''Data'''
 
−
| A pointer to private data to be passed to the callback (Optional)
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowCheckFlag(Handle:TWindowHandle;Flag:LongWord):Boolean;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Check an existing console window to determine if a flag is set or not
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to check
 
−
|-
 
−
! '''Flag'''
 
−
| The window flag to check for (eg WINDOW_FLAG_LINE_WRAP")
 
−
|-
 
−
! '''Return'''
 
−
| True if the flag is set, False if not set
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetMode(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the window mode of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get the mode for
 
−
|-
 
−
! '''Return'''
 
−
| The window mode (eg WINDOW_MODE_TEXT)
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
function ConsoleWindowGetState(Handle:TWindowHandle):LongWord;
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowCreate(Console:PConsoleDevice;Position:LongWord;Default:Boolean):TWindowHandle;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the window state of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get the state for
 
−
|-
 
−
! '''Return'''
 
−
| The window state (eg WINDOW_STATE_INVISIBLE)
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetPosition(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the position of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get the position for
 
−
|-
 
−
! '''Return'''
 
−
| The window position (eg CONSOLE_POSITION_FULL)
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowSetPosition(Handle:TWindowHandle;Position:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Set the position of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to set the position for
 
−
|-
 
−
! '''Position'''
 
−
| The new window position to set
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
! '''Note'''
 
−
| The function will return ERROR_INVALID_PARAMETER if another window exists at the position
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetMinX(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the current minimum X of the window viewport for an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get MinX for
 
−
|-
 
−
! '''Return'''
 
−
| The minimum X value for the current window viewport
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, X is based on character columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetMinY(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the current minimum Y of the window viewport for an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get MinY for
 
−
|-
 
−
! '''Return'''
 
−
| The minimum Y value for the current window viewport
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, Y is based on character rows not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetMaxX(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the current maximum X of the window viewport for an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get MaxX for
 
−
|-
 
−
! '''Return'''
 
−
| The maximum X value for the current window viewport
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, X is based on character columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetMaxY(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the current maximum Y of the window viewport for an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get MaxY for
 
−
|-
 
−
! '''Return'''
 
−
| The maximum Y value for the current window viewport
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, Y is based on character rows not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetRect(Handle:TWindowHandle):TConsoleRect; inline;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the rectangle X1,Y1,X2,Y2 of the window viewport for an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get the rectangle for
 
−
|-
 
−
! '''Return'''
 
−
| The rectangle of the current window viewport
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, Rect is based on character rows and columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowSetRect(Handle:TWindowHandle;const ARect:TConsoleRect):LongWord; inline;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Set the rectangle X1,Y1,X2,Y2 of the window viewport for an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to set the rectangle for
 
−
|-
 
−
! '''Rect'''
 
−
| The rectangle to set for the window viewport
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, Rect is based on character rows and columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetViewport(Handle:TWindowHandle;var X1,Y1,X2,Y2:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the X1,Y1,X2,Y2 of the window viewport for an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get the viewport for
 
−
|-
 
−
! '''X1'''
 
−
| The left edge of the current viewport
 
−
|-
 
−
! '''Y1'''
 
−
| The top edge of the current viewport
 
−
|-
 
−
! '''X2'''
 
−
| The right edge of the current viewport
 
−
|-
 
−
! '''Y2'''
 
−
| The bottom edge of the current viewport
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, Viewport is based on character rows and columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowSetViewport(Handle:TWindowHandle;X1,Y1,X2,Y2:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Set the X1,Y1,X2,Y2 of the window viewport for an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get the viewport for
 
−
|-
 
−
! '''X1'''
 
−
| The left edge of the window viewport
 
−
|-
 
−
! '''Y1'''
 
−
| The top edge of the window viewport
 
−
|-
 
−
! '''X2'''
 
−
| The right edge of the window viewport
 
−
|-
 
−
! '''Y2'''
 
−
| The bottom edge of the window viewport
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, Viewport is based on character rows and columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetX(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the current X (Column) position of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get X for
 
−
|-
 
−
! '''Return'''
 
−
| The X value for the window
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, X is based on character columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowSetX(Handle:TWindowHandle;X:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| CSet the current X (Column) position of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to set X for
 
−
|-
 
−
! '''X'''
 
−
| The new X value to set
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, X is based on character columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetY(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the current Y (Row) position of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get Y for
 
−
|-
 
−
! '''Return'''
 
−
| The Y value for the window
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, Y is based on character rows not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowSetY(Handle:TWindowHandle;Y:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Set the current Y (Row) position of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to set Y for
 
−
|-
 
−
! '''Y'''
 
−
| The new Y value to set
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, Y is based on character rows not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetXY(Handle:TWindowHandle;var X,Y:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the current X and Y positions of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get X and Y for
 
−
|-
 
−
! '''X'''
 
−
| The returned X value
 
−
|-
 
−
! '''Y'''
 
−
| The returned Y value
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, X and Y are based on character rows and columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowSetXY(Handle:TWindowHandle;X,Y:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Set the current X and Y positions of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to set X and Y for
 
−
|-
 
−
! '''X'''
 
−
| The new X value
 
−
|-
 
−
! '''Y'''
 
−
| The new Y value
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, X and Y are based on character rows and columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetPoint(Handle:TWindowHandle):TConsolePoint;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the point X,Y of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get the point for
 
−
|-
 
−
! '''Return'''
 
−
| The current point of the window
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, Point is based on character rows and columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowSetPoint(Handle:TWindowHandle;const APoint:TConsolePoint):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Set the point X,Y of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to set the point for
 
−
|-
 
−
! '''Point'''
 
−
| The new point to set for the window
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, Point is based on character rows and columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetCols(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the current columns of the window viewport for an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get columns for
 
−
|-
 
−
! '''Return'''
 
−
| The columns value for the current window viewport
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, Columns is based on character columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetRows(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the current rows of the window viewport for an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get rows for
 
−
|-
 
−
! '''Return'''
 
−
| The rows value for the current window viewport
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, Rows is based on character rows not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetWidth(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the absolute width of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get the width for
 
−
|-
 
−
! '''Return'''
 
−
| The absolute width of the window
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, Width is based on character columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetHeight(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the absolute height of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get the height for
 
−
|-
 
−
! '''Return'''
 
−
| The absolute height of the window
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, Height is based on character rows not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetFormat(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the color format of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get the format for
 
−
|-
 
−
! '''Return'''
 
−
| The color format of the window (eg COLOR_FORMAT_ARGB32)
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetForecolor(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the current foreground color of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get the foreground color for
 
−
|-
 
−
! '''Return'''
 
−
| The foreground color of the window (eg COLOR_WHITE)
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowSetForecolor(Handle:TWindowHandle;Color:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Set the current foreground color of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to set the foreground color for
 
−
|-
 
−
! '''Color'''
 
−
| The foreground color to set (eg COLOR_WHITE)
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetBackcolor(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the current background color of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get the background color for
 
−
|-
 
−
! '''Return'''
 
−
| The background color of the window (eg COLOR_BLACK)
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowSetBackcolor(Handle:TWindowHandle;Color:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Set the current background color of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to set the background color for
 
−
|-
 
−
! '''Color'''
 
−
| The background color to set (eg COLOR_BLACK)
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetFont(Handle:TWindowHandle):TFontHandle;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Get the default font of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to get the default font for
 
−
|-
 
−
! '''Return'''
 
−
| The font handle of the default font or INVALID_HANDLE_VALUE on error
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowSetFont(Handle:TWindowHandle;Font:TFontHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Set the default font of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to set the default font for
 
−
|-
 
−
! '''Font'''
 
−
| The font handle of the default font to set
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console windows, setting the font also clears the window
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetCursorXY(Handle:TWindowHandle;var X,Y:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowSetCursorXY(Handle:TWindowHandle;X,Y:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetCursorBlink(Handle:TWindowHandle):Boolean;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowSetCursorBlink(Handle:TWindowHandle;CursorBlink:Boolean):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowGetCursorState(Handle:TWindowHandle):TCursorState;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowSetCursorState(Handle:TWindowHandle;CursorState:TCursorState):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowCursorOn(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowCursorOff(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowCursorMove(Handle:TWindowHandle;X,Y:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowCursorBlink(Handle:TWindowHandle;Enabled:Boolean):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowScrollUp(Handle:TWindowHandle;Row,Lines:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
! '''Note'''
 
−
| Row is the starting row (Y) for the scroll up, all rows from top plus Lines down to Row will be scrolled up. Lines is the number of character lines to scroll up, Lines number of rows at the top will be discarded. The starting Row will be blanked with the background color.
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowScrollDown(Handle:TWindowHandle;Row,Lines:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
! '''Note'''
 
−
| Row is the starting row (Y) for the scroll down, all rows from bottom minus Lines up to Row will be scrolled down. Lines is the number of character lines to scroll down, Lines number of rows at the bottom will be discarded. The starting Row will be blanked with the background color.
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowScrollLeft(Handle:TWindowHandle;Row,Col,Lines,Chars:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowScrollRight(Handle:TWindowHandle;Row,Col,Lines,Chars:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowClear(Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Clear the current viewport of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to clear
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowClearEx(Handle:TWindowHandle;X1,Y1,X2,Y2:LongWord;Cursor:Boolean):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Clear part of the the current viewport of an existing console window
 
−
|-
 
−
! '''Handle'''
 
−
| The handle of the window to clear
 
−
|-
 
−
! '''X1'''
 
−
| The left edge of the area to clear (relative to current viewport)
 
−
|-
 
−
! '''Y1'''
 
−
| The top edge of the area to clear (relative to current viewport)
 
−
|-
 
−
! '''X2'''
 
−
| The right edge of the area to clear (relative to current viewport)
 
−
|-
 
−
! '''Y2'''
 
−
| The bottom edge of the area to clear (relative to current viewport)
 
−
|-
 
−
! '''Cursor'''
 
−
| If True update the cursor position after clearing
 
−
|-
 
−
! '''Return'''
 
−
| ERROR_SUCCESS if completed or another error code on failure
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, Window is based on screen character rows and columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowWrite(Handle:TWindowHandle;const AText:String):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowWriteEx(Handle:TWindowHandle;const AText:String;X,Y:LongWord;Forecolor,Backcolor:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, X and Y are based on screen character rows and columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowWriteLn(Handle:TWindowHandle;const AText:String):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowWriteLnEx(Handle:TWindowHandle;const AText:String;X,Y:LongWord;Forecolor,Backcolor:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, X and Y are based on character rows and columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowWriteChr(Handle:TWindowHandle;AChr:Char):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWindowWriteChrEx(Handle:TWindowHandle;AChr:Char;X,Y:LongWord;Forecolor,Backcolor:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
! '''Note'''
 
−
| For Text Console functions, X and Y are based on character rows and columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
 
−
'''CRT console functions'''
 
−
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleAssignCrt(var F:Text);</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function AssignCrt
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/assigncrt.html
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleClrEol;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function ClrEol
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/clreol.html
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleClrScr;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function ClrScr
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/clrscr.html
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleDelay(MS:Word);</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function Delay
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/delay.html
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleDelLine;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function DelLine
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/delline.html
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleGotoXY(X,Y:Integer);</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function GotoXY
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/gotoxy.html
 
−
|-
 
−
! '''Note'''
 
−
| For CRT Console functions, X and Y are based on character rows and columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleHighVideo;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function HighVideo
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/highvideo.html
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleInsLine;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function InsLine
 
−
|-
 
−
! '''See'''
 
−
| See: http://www.freepascal.org/docs-html-3.0.0/rtl/crt/insline.html
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleKeypressed:Boolean;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function KeyPressed
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/keypressed.html
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleLowVideo;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function LowVideo
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/lowvideo.html
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleNormVideo;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function NormVideo
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/normvideo.html
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleNoSound;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function NoSound
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/nosound.html
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleReadKey:Char;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function ReadKey
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/readkey.html
 
−
|-
 
−
! '''Note'''
 
−
| For extended key scan codes see: http://www.freepascal.org/docs-html/rtl/keyboard/kbdscancode.html
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleSound(Hz:Word);</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function Sound
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/sound.html
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleTextBackground(Color:LongWord);</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function TextBackground
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/textbackground.html
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleTextColor(Color:LongWord);</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function TextColor
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/textcolor.html
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleTextMode(Mode:Integer);</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function TextMode
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/textmode.html
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWhereX:Integer;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function WhereX
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/wherex.html
 
−
|-
 
−
! '''Note'''
 
−
| For CRT Console functions, X is based on character columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function ConsoleWhereY:Integer;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function WhereY
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/wherey.html
 
−
|-
 
−
! '''Note'''
 
−
| For CRT Console functions, Y is based on character row not screen pixel
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleWindow(X1,Y1,X2,Y2:Integer);</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Compatible with RTL Crt unit function Window
 
−
|-
 
−
! '''See'''
 
−
| http://www.freepascal.org/docs-html-3.0.0/rtl/crt/window.html
 
−
|-
 
−
! '''Note'''
 
−
| For CRT Console functions, X1, Y1, X2 and Y2 are based on character rows and columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleScrollUp(Row,Lines:Integer);</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
! '''Note'''
 
−
| For CRT Console functions, Row and Lines are based on character rows and columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleScrollDown(Row,Lines:Integer);</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
! '''Note'''
 
−
| For CRT Console functions, Row and Lines are based on character rows and columns not screen pixels
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleWrite(const AText:String);</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleWriteLn(const AText:String);</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleWriteChr(AChr:Char);;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleRead(var AText:String);</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Read text from console input and echo to screen
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleReadLn(var AText:String);</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Read text from console input and echo to screen
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">procedure ConsoleReadChr(var AChr:Char);</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| Read characters from console input and echo to screen
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
 
−
'''RTL console functions'''
 
−
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function SysConsoleWriteChar(ACh:Char;AUserData:Pointer):Boolean;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
 
−
'''Framebuffer console functions'''
 
−
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function FramebufferConsoleOpen(Console:PConsoleDevice):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function FramebufferConsoleClose(Console:PConsoleDevice):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function FramebufferConsoleClear(Console:PConsoleDevice;Color:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function FramebufferConsoleScroll(Console:PConsoleDevice;X1,Y1,X2,Y2,Count,Direction:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function FramebufferConsoleDrawBox(Console:PConsoleDevice;X1,Y1,X2,Y2,Color,Width:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function FramebufferConsoleDrawLine(Console:PConsoleDevice;X1,Y1,X2,Y2,Color,Width:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function FramebufferConsoleDrawChar(Console:PConsoleDevice;Handle:TFontHandle;Ch:Char;X,Y,Forecolor,Backcolor:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function FramebufferConsoleDrawText(Console:PConsoleDevice;Handle:TFontHandle;const Text:String;X,Y,Forecolor,Backcolor,Len:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function FramebufferConsoleDrawPixel(Console:PConsoleDevice;X,Y,Color:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function FramebufferConsoleDrawBlock(Console:PConsoleDevice;X1,Y1,X2,Y2,Color:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function FramebufferConsoleDrawImage(Console:PConsoleDevice;X,Y:LongWord;Buffer:Pointer;Width,Height,Format,Skip:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function FramebufferConsoleDrawWindow(Console:PConsoleDevice;Handle:TWindowHandle):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
! '''Note'''
 
−
| Caller must hold the Window lock
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function FramebufferConsoleDrawDesktop(Console:PConsoleDevice):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function FramebufferConsoleGetPixel(Console:PConsoleDevice;X,Y:LongWord;var Color:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function FramebufferConsoleGetImage(Console:PConsoleDevice;X,Y:LongWord;Buffer:Pointer;Width,Height,Format,Skip:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function FramebufferConsoleCopyImage(Console:PConsoleDevice;const Source,Dest:TConsolePoint;Width,Height:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 
−
<code style="padding:10px;">function FramebufferConsoleGetPosition(Console:PConsoleDevice;Position:LongWord;var X1,Y1,X2,Y2:LongWord):LongWord;</code>
 
−
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 
−
{| class="wikitable" style="font-size: 14px; background:white;"
 
−
|-
 
−
! '''Description'''
 
−
| To be documented
 
−
|-
 
−
|}
 
−
</div></div>
 
−
<br />
 
  
 
Return to [[Unit_Reference|Unit Reference]]
 
Return to [[Unit_Reference|Unit Reference]]

Revision as of 01:02, 27 July 2016

Return to Unit Reference


Description

To be documented

Constants

To be documented

Type definitions

To be documented

Public variables

To be documented

Function declarations

To be documented


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_Console&oldid=310"