Subroutine Documentation
Last update: 2-July-2003
This documents the functions, constants, and classes found in the subroutine library. Note that for any routines returning a Pchar or char* value, unless otherwise stated, the value is only valid until the next call to the routine. Thus, if the value is required over a long period of time, a local copy should be made. Further, unless otherwise stated, any Pchar or char* value passed to a routine in the subroutine library need only be valid during that call.
ACK
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 6 (Acknowledge).
Add_Commas
File: ustrings.c
Type: void function
Parameters:
Name |
Type |
Description |
X |
char* |
The number, in string form, to which to add commas. |
Description:
This function adds commas in the appropriate places to the passed string. The buffer for the passed string must be large enough to accommodate the added commas.
Add_Handler
File: cache.c
Type: void function
Parameters:
Name |
Type |
Description |
Routine |
Void (*Routine)(int, int) |
The cache handler routine to add to the list of cache handlers. |
Priority |
long int |
The priority to assign to the associated cache. Lower priority caches are targeted first when memory needs to be reclaimed. |
Description:
This routine adds a cache handler function to the list of all cache handlers. When some cache must be freed to make memory available, the cache handler iterates through this list, in priority order, trying to free memory from the lowest priority caches first.
Add_Handler
File: cache.pas
Type: procedure
Parameters:
Name |
Type |
Description |
Routine |
Tcache_Handler |
The cache handler routine to add to the list of cache handlers. |
Priority |
longint |
The priority to assign to the associated cache. Lower priority caches are targeted first when memory needs to be reclaimed. |
Description:
This routine adds a cache handler function to the list of all cache handlers. When some cache must be freed to make memory available, the cache handler iterates through this list, in priority order, trying to free memory from the lowest priority caches first.
Adjust
File: teu.c
Type: void function
Parameters: None
Description:
Adjust the TEU cursor position based on tabs, EOL, etc.
Adjust_Button_Panel
File: vcl_std.pas
Type: procedure
Parameters:
Name |
Type |
Description |
|
|
TwinControl |
Control whose children will be adjusted. |
Description:
Adjusts the children of the passed control so that they are spread evenly across the control. Only horizontal adjustments are currently supported. Note that the children are kept in the same left-to-right order, but vertical positions are unchanged.
Anchor_Type
File: teu.h
Type: struct
Fields:
Name |
Type |
Description |
Line |
long int |
Line number. |
Column |
short int |
Logical column. |
P_Column |
short int |
Physical column. |
Description:
This structure defines an anchor point for a selection in TEU.
Align_To_String
File: VCLDebug.pas
Type: string function
Parameters:
Name |
Type |
Description |
X |
Talign |
Alignment to convert to a string value. |
Description:
This function returns a string containing human-readable alignment.
Anchor_Type
File: ueditor.pas
Type: record
Fields:
Name |
Type |
Description |
Line |
Longint |
Line number. |
End_Line |
longint |
Ending line number. |
Column |
Byte |
Logical column. |
P_Column |
Byte |
Physical column. |
End_Column |
Byte |
Ending logical column. |
End_P_Column |
byte |
Ending physical column. |
Description:
This structure defines an anchor point for a selection in UEditor.
Anchors_To_String
File: VCLDebug.pas
Type: string function
Parameters:
Name |
Type |
Description |
X |
Tanchors |
Anchors to convert to a string value. |
Description:
This function returns a string containing human-readable anchors.
ANSIChar
File: typedefs.pas
Type: type
Description:
Synonym for char.
APC
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 159.
Arabic_To_Roman
File: cvt.c
Type: char* function.
Parameters:
Name |
Type |
Description |
X |
int |
Number for which to return Roman numeral equivalent. |
Description:
This function returns a string containing Roman numerals equal to the passed value. For instance if 5 is passed, "V" is returned.
ArcCos
File: maths.pas
Type: extended function
Parameters:
Name |
Type |
Description |
X |
extended |
Value for which to return arc cosine. |
Description:
Returns Arc Cosine of passed value.
ArcCoT
File: maths.pas
Type: extended function
Parameters:
|
Type |
Description |
X |
extended |
Value for which to return arc cotangent. |
Description:
Returns Arc Cotangent of passed value.
ArcCSc
File: maths.pas
Type: extended function
Parameters:
Name |
Type |
Description |
X |
extended |
Value for which to return arc cosecant. |
Description:
Returns Arc Cosecant of passed value.
ArcSec
File: maths.pas
Type: extended function
Parameters:
Name |
Type |
Description |
|
extended |
Value for which to return arc secant. |
Description:
Returns Arc Secant of passed value.
ArcSin
File: maths.pas
Type: extended function
Parameters:
|
Type |
Description |
X |
extended |
Value for which to return arc sine. |
Description:
Returns Arc Sine of passed value.
ASCII_Codes
File: asciidef.pas
Type: String function.
Parameters:
Name |
Type |
Description |
Value |
Integer |
ASCII code to return a string equivalent for. |
Description:
This function returns the ASCII string code for the passed value. If the supplied value is 127 or less than 32, the three-character ASCII code is returned (e.g. "NUL" is returned for 0). Otherwise, the ASCII character is returned.
BEL
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 7 (Bell).
BiDiMode_To_String
File: VCLDebug.pas
Type: string function
Parameters:
Name |
Type |
Description |
X |
TBiDiMode |
Bi-directional mode to convert to a string value. |
Description:
This function returns a string containing human-readable bi-directional mode.
Bit_Values
File: standard.pas
Type: array[ 0..31 ] of longint
Description:
This array contains powers of 2 from 0 to 31. For instance Bit_Values[ 10 ] is 1024. See also Xbit_Values.
Boolean_To_String
File: ustrings.pas
Type: string function
Parameters:
Parameter |
Type |
Description |
X |
Boolean |
Value for which to return string equivalent. |
Description:
Returns "True" or "False", depending on the parameter.
BS
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 8 (Backspace).
CAN
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 24 (Cancel).
CC_Log
File: standard.pas
Type: procedure
Parameters:
Parameter |
Type |
Description |
X |
String |
Value to log. |
Description:
If the "CCLOG" environment variable is defined, its value is used as a filename. This file is opened and the passed value is appended to that file including the current date, time, and program, and version from Globals.pas.
CCH
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 148.
CCPos
File: io.asm
Type: DB
Description:
Current output buffer column.
CheckDOS
File: standard.pas
Type: boolean function (DOS only)
Parameters: None
Description:
Returns true if the current version of MSDOS/PCDOS supports undocumented functions.
Clear_Cursor
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Name |
Type |
Description |
Vr |
Integer |
SMU window row. |
Vc |
Integer |
SMU window column. |
Description:
Clears the cursor at the specified location on the default window.
_Clear_Cursor
File: smubios.pas
Type: procedure
Parameters:
Name |
Type |
Description |
Vr |
Byte |
SMU window row. |
Vc |
Byte |
SMU window column. |
Background |
Byte |
Background color for graphics mode. |
Foreground |
Byte |
Foreground color for graphics mode. |
Attribute |
Byte |
Text attribute if in text mode. |
Description:
Clears the cursor at the specified location on the default window.
Clear_Type_Ahead
File: getchars.c
Type: void function
Parameters: None
Description:
Clears the DOS input buffer.
Clear_Window
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Name |
Type |
Description |
Window_P |
Pwindow |
SMU window to clear. |
Description:
Clears the data and attributes of the entire specified SMU window.
ClearIn
File: input.asm
Type: routine
Parameters: None (no registers are changed by this routine)
Description:
Clears the input buffer (sets it to length of 0) in io.asm.
Close_File_System
File: files.pas
Type: procedure
Parameters:
Name |
Type |
Description |
Name |
String |
Specification of file system to close. File system must have been previously opened with Open_File_System. |
Description:
This procedure closes a file system previously opened with Open_File_System. If there are no other references to the file system (such as open files), the file system object is destructed.
Closest_Power_Of_2
File: misc.pas
Type: longint function
Parameters:
Name |
Type |
Description |
X |
longint |
Value to check. |
Description:
This function returns the power of 2 closest to the passed value. The result is always greater than or equal to the passed value.
Closest_Power_Of_2_Ex
File: misc.pas
Type: int64 function (Delphi)
Parameters:
Name |
Type |
Description |
X |
Int64 |
Value to check. |
Description:
This function returns the power of 2 closest to the passed value. The result is always greater than or equal to the passed value.
Command_Line
File: standard.pas
Type: string function
Parameters: None
Description:
This function returns the command line used to invoke the program.
Compare_Memory
File: standard.pas
Type: boolean function
Parameters:
Parameter |
Type |
Description |
X |
Any |
First variable to compare. |
Y |
Any |
Second variable to compare. |
Size |
longint |
Number of bytes to compare. |
Description:
This function compares an arbitrary number of bytes of two locations of memory and returns True if the memory at those locations is identical.
Compare_Strings
File: ustrings.pas
Type: double function
Parameters:
Name |
Type |
Description |
String1 |
String |
First string to compare. |
String2 |
String |
Second string to compare. |
X |
RComparison |
Comparison rules. |
Description:
This function will return a comparison value that is the percentage of closeness of the two strings (between 0 and 1).
Component_Debugger
File: VCLDebug.pas
Type: PDebug_Interface function
Parameters:
Name |
Type |
Description |
C |
Tcomponent |
Component for which to return a debug interface. |
Description:
This function returns a debug interface object for the passed component.
Component_Description
File: VCLDebug.pas
Type: string function
Parameters:
Name |
Type |
Description |
C |
Tcomponent |
Component for which to return a description. |
Description:
This function returns a description for the passed component.
ComponentState_To_String
File: VCLDebug.pas
Type: string function
Parameters:
Name |
Type |
Description |
X |
TComponentState |
ComponentState for which to return a description. |
Description:
This function returns a description for the passed component state.
ComponentStyle_To_String
File: VCLDebug.pas
Type: string function
Parameters:
Name |
Type |
Description |
X |
TComponentStyle |
ComponentStyle for which to return a description. |
Description:
This function returns a description for the passed component style.
Connected_To_Internet
File: Internet_Util.pas
Type: boolean function
Parameters: None
Description:
This function returns true if the computer is connected to the Internet, and false if not. Note that a false positive can sometimes be returned. That is to say that a True result does not guarantee an Internet connection, but a False result guarantees that there is not.
ControlState_To_String
File: VCLDebug.pas
Type: string function
Parameters:
Name |
Type |
Description |
X |
TControlState |
ControlState for which to return a description. |
Description:
This function returns a description for the passed control state.
ControlStyle_To_String
File: VCLDebug.pas
Type: string function
Parameters:
Name |
Type |
Description |
X |
TControlStyle |
ControlStyle for which to return a description. |
Description:
This function returns a description for the passed control style.
File: maths.pas
Type: extended function
Parameters:
Name |
Type |
Description |
X |
extended |
Value for which to return |
Description:
Returns Cotangent of passed value.
CR
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 13 (Carriage return).
Create_Window
File: smu.c, smu.pas
Type: Window* function (C), Pwindow function (Pascal)
Parameters:
Name |
Type |
Description |
Row_Count |
Integer |
Number of rows in window. |
Column_Count |
Integer |
Number of columns in window. |
Flag |
Integer |
Flags for window (see Window structure for details). |
Description:
Creates a new SMU window.
Create_Window_Wrapper
File: smu.pas
Type: PWindow (Windows only)
Parameters:
Name |
Type |
Description |
Handle |
Hwnd |
Windows window handle. |
Description:
This function returns an SMU window which is actually the passed Windows window.
CRLF
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
Returns a combination of CR and LF (carriage return/line feed).
CSc
File: maths.pas
Type: extended function
Parameters:
Name |
Type |
Description |
X |
extended |
Value for which to return Cosecant. |
Description:
Returns Cosecant of passed value.
CSI
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 155.
Current_Window
File: smu.c, smu.pas
Type: Window* function (C), Pwindow function (Pascal)
Parameters: None
Description:
This function returns the default SMU window.
Cursor_Down
File: teu.c
Type: void function
Parameters: None
Description:
This function moves the TEU cursor down one line.
Cursor_Left
File: teu.c
Type: void function
Parameters: None
Description:
This function moves the TEU cursor left one character.
Cursor_Right
File: teu.c
Type: void function
Parameters: None
Description:
This function moves the TEU cursor right one character.
Cursor_To_String
File: VCLDebug.pas
Type: string function
Parameters:
Name |
Type |
Description |
X |
TCursor |
Cursor for which to return a description. |
Description:
This function returns a description for the passed cursor.
Cursor_Up
File: teu.c
Type: void function
Parameters: None
Description:
This function moves the TEU cursor up one line.
CvtB
File: cvt.pas, cvt.c
Type: string function (Pascal), char* function (C)
Parameters:
Name |
Type |
Description |
Base1 |
Integer |
Base to convert from. |
Base2 |
Integer |
Base to convert to. |
X |
String |
Value to convert. |
Description:
This function converts a value in one base to the same value in another base. Legal base values are 1 to 49. Bases outside of this range may or may not yield correct results. Invalid characters for the source base in X may cause random results or errors. For example, if Base1 is 16 and Base2 is 10 and X is "F", the result will be "15".
Date
File: dates.pas, standard.c
Type: string function (Pascal), char* function (C)
Parameters: none
Description:
This function returns the current date in "DD-MMM-YYYY" format.
DateTime
File: compatib.pas
Type: record (Delphi)
Fields:
Field |
Type |
Description |
||
Year |
Word |
Year. |
||
Month |
Word |
Month (1-12). |
||
Day |
Word |
Day (1-31). |
||
Hour |
Word |
Hour (0-23). |
||
Min |
Word |
Minute (0-59). |
||
Sec |
Word |
Second (0-59). |
Description:
This record defines the Borland Pascal DateTime record.
Day
File: dates.pas, dates.c
Type: string function (Pascal), char* function (C)
Parameters:
Parameter |
Type |
Description |
Date |
String |
Date to determine the day of week for. This date must be in one of the following formats: d-mmm-yy, d-mmm-yyyy, dd-mmm-yy, dd-mmm-yyyy, or yy.mm.dd |
Description:
Returns the name of the specified date ( "Sunday", "Monday", etc).
Day_*
File: dates.pas
Type: constants
Description:
These constants provide mnemonics for days of the week.
Mnuemonic |
Value |
Meaning |
|
Day_Sunday |
1 |
Sunday |
|
Day_Monday |
2 |
Monday |
|
Day_Tuesday |
3 |
Tuesday |
|
Day_Wednesday |
4 |
Wednesday |
|
Day_Thursday |
5 |
Thursday |
|
Day_Friday |
6 |
Friday |
|
Day_Saturday |
7 |
Saturday |
DayVal
File: dates.pas, dates.c
Type: integer function (Pascal), int function (C)
Parameters:
Parameter |
Type |
Description |
Date |
String |
Date to determine day of week for. This date must be in one of the following formats: d-mmm-yy, d-mmm-yyyy, dd-mmm-yy, dd-mmm-yyyy, or yy.mm.dd |
Description:
Returns the day of the week for the passed date (1 = Sunday, 2 = Monday,… 7 = Saturday).
DC1
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 17 (Direct control 1).
DC2
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 18 (Direct control 2).
DC3
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 19 (Direct control 3).
DC4
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 20 (Direct control 4).
DCS
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 144.
Deg
Type: extended function
Parameters:
Name |
Type |
Description |
X |
extended |
Radian to convert. |
Description:
Converts passed value from Radian to Degree.
DEL
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 127 (Delete).
Delete_Handler
File: cache.c
Type: void function
Parameters:
Name |
Type |
Description |
Routine |
void (*Routine)(int, int) |
Cache handler routine to remove |
Description:
This routine removes a cache handler function from the list of cache handlers.
Delete_Char
File: teu.c
Type: void function
Parameters:
Name |
Type |
Description |
Explicit |
int |
True if this is an explicit delete (from the user). False if implied. |
Description:
This function deletes the character at the current TEU cursor position.
Delete_Handler
File: cache.pas
Type: procedure
Parameters:
Name |
Type |
Description |
Routine |
Tcache_Handler |
Cache handler routine to remove |
Description:
This routine removes a cache handler function from the list of cache handlers.
Delete_Line
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Name |
Type |
Description |
Window_P |
Pwindow |
SMU window to modify. |
Direction |
Byte |
Indicates the direction of scrolling. 0 = up (gain blank top line), 1 = down (gain blank bottom line). |
Description:
Deletes the entire cursor line, scrolling the appropriate rows into the vacancy.
Delete_Window
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Name |
Type |
Description |
WP |
Pwindow |
SMU window to delete. |
Description:
This function unmaps and deletes the specified window. The window pointer is no longer valid after this call.
Deletecrlf
File: teu.c
Type: void function
Parameters:
Name |
Type |
Description |
Explicit |
Int |
True if this is an explicit delete operation (from user). False if implied. |
Description:
This function deletes the end of a line at the cursor, merging two lines into one.
DeviceFree
File: files.pas
Type: int64
Parameters:
Name |
Type |
Description |
Nam |
String |
Name of device for which to return free space. |
Description:
Returns the amount of free space on the specified device, in bytes.
DeviceSize
File: files.pas
Type: int64
Parameters:
Name |
Type |
Description |
Nam |
String |
Name of device for which to return size. |
Description:
Returns the total size of the specified device, in bytes.
Disk_Read
File: disk.pas
Type: procedure
Parameters:
Name |
Type |
Description |
Unit_Number |
Smallint |
Unit number to read from. |
Sector |
Smallint |
Sector to read from. |
Count |
Smallint |
Number of sectors to read. |
Buf |
Const |
Buffer to read into. |
Result |
Var smallint |
Ignored when passed. Result of read on return (0 = success). |
Flags |
Var smallint |
Ignored when passed. |
Description:
This is an absolute disk read procedure.
Disk_Write
File: disk.pas
Type: procedure
Parameters:
Name |
Type |
Description |
Unit_Number |
Smallint |
Unit number to write to. |
Sector |
Smallint |
Starting sector to write to. |
Count |
Smallint |
Number of sectors to write. |
Result |
Var smallint |
Ignored when passed. Result of write on return (0 = success). |
Flags |
Var smallint |
Ignored when passed. |
Description:
This is an absolute disk write procedure.
DLE
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 16 (Data Link Escape).
Do_Change
File: teu.c
Type: void function
Parameters: None
Description:
Marks the TEU buffer as having been modified.
Do_Help
File: teu.c
Type: void function
Parameters: None
Description:
Displays TEU help on the screen.
Do_Read
File: teu.c
Type: void function
Parameters: None
Description:
Reads the next key typed by the user. Note that the data may come from the keyboard, an executing macro, or the journal file.
Do_Search
File: teu.c
Type: void function
Parameters: None
Description:
Searches for text.
Do_Update
File: teu.c
Type: void function
Parameters: None
Description:
Update memory with current edited line - if needed.
Do_Write
File: teu.c
Type: void function
Parameters:
Name |
Type |
Description |
Command |
char* |
Name of output file. |
File_Root |
Line_Record* |
Buffer to write. |
Description:
Writes the specified buffer to the specified file.
DocOrientation_To_String
File: VCLDebug.pas
Type: string function
Parameters:
Name |
Type |
Description |
X |
T DocOrientation |
Dock orientation for which to return a description. |
Description:
This function returns a description for the passed dock orientation.
Draw_Line
File: lines.pas
Type: procedure (Delphi)
Parameters:
Name |
Type |
Description |
C |
TCanvas |
Canvas to draw upon. |
A |
Tpoint |
Starting point of line. |
B |
TPoint |
Ending point of line. |
Description:
Draws a black line between the specified points on the specified canvas.
Draw_Polygon
File: lines.pas
Type: procedure (Delphi)
Parameters:
Name |
Type |
Description |
C |
TCanvas |
Canvas to draw upon. |
Bitmap |
TTexture |
Texture with which to fill polygon. |
Points |
Array of TPoint |
Open array of points defining polygon. A line is implicit between each adjacent point. The last point is adjacent to the first point. |
Description:
Draws a textured polygon.
EBCDIC
File: cvt.pas
Type: string function
Parameters:
Name |
Type |
Description |
ASCII |
String |
ASCII string to convert |
Description:
Returns the EBCDIC equivalent of the passed ASCII string.
EBCDIC_To_ASCII
File: cvt.pas
Type: string function
Parameters:
Name |
Type |
Description |
EBCDIC |
String |
EBCDIC string to convert. |
Description:
Returns the ASCII equivalent of the passed EBCDIC string.
EBS
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 254 (Extended backspace).
Edit
File: edit.asm
Type: routine
Parameters:
Register |
Description |
CX |
Editing flags (see description). |
Description:
Edits the string in InpBuff and places the result in WorkBuff. Flags indicate the editing operations to perform:
Flag |
Description |
AND 1 |
Reserved |
AND 2 |
Remove all spaces and tabs |
AND 4 |
Remove all nulls, linefeeds, formfeeds, carriage returns, and deletes. |
AND 8 |
Remove leading spaces |
AND 16 |
Reduce spaces and tabs to one space |
AND 32 |
Convert lower to upper case |
AND 64 |
Convert "(" to "[" and ")" to "]" |
AND 128 |
Remove all trailing spaces |
AND 256 |
Leave quoted characters unmodified |
AND 512-32768 |
Reserved |
Edit
File: edit.c
Type: routine
Parameters:
Name |
Type |
Description |
Dst |
char* |
Where to placed edited string. This must point to a buffer large enough to hold the edited string, plus the null character. To be safe, this buffer should be of size strlen(Src)+1. |
Src |
char* |
String to edit. |
Flags |
int |
Editing flags (see description). |
Description:
Edits the string in Src and places the result in Dst. Flags indicate the editing operations to perform:
Flag |
Description |
AND 1 |
Trim most significant bit |
AND 2 |
Remove all spaces and tabs |
AND 4 |
Remove all linefeeds, formfeeds, carriage returns, and deletes |
AND 8 |
Remove leading spaces |
AND 16 |
Reduce spaces and tabs to one space |
AND 32 |
Convert lower to upper case |
AND 64 |
Convert "(" to "[" and ")" to "]" |
AND 128 |
Remove all trailing spaces |
AND 256 |
Leave quoted characters unmodified |
AND 512 |
Convert upper to lower case |
AND 1024 |
Convert "[" to "{" and "]" to "}" |
AND 2048 |
Convert "(" to "[" and ")" to "]" |
AND 4096 |
Convert "(" to "{" and ")" to "}" |
AND 8192 |
Convert "{" to "(" and "}" to ")" |
AND 16384 |
Convert "{" to "[" and "}" to "]" |
AND 32768 |
Reserved |
Edit
File: standard.pas
Type: string function
Parameters:
Parameter |
Type |
Description |
Original |
String |
The string to edit. |
Flags |
longint |
Editing flags (see description). |
Description:
This function returns the passed string, modified as requested in the Flags value (note that conflicting flags are resolved to the lowest-valued flag):
Flag |
Description |
AND 1 |
Trim Most Significant Bit of each character. |
AND 2 |
Remove all spaces and tabs. |
AND 4 |
Remove all nulls, linefeeds, formfeeds, carriage returns, and deletes. |
AND 8 |
Remove leading spaces. |
AND 16 |
Reduce spaces and tabs to one space. |
AND 32 |
Convert lower to upper case. |
AND 64 |
Convert "(" to "[" and ")" to "]". |
AND 128 |
Remove all trailing spaces. |
AND 256 |
Leave quoted characters unmodified. |
AND 512 |
Convert upper case to lower case. |
AND 1024 |
Convert "[" to "{" and "]" to "}". |
AND 2048 |
Convert "(" to "[" and ")" to "]". |
AND 4096 |
Convert "(" to "{" and ")" to "}". |
AND 8192 |
Convert "{" to "(" and "}" to ")". |
AND 16384 |
Convert "{" to "[" and "}" to "]". |
AND 32768 |
Covert case on Windows high-ASCII latin characters and treat ASCII 160 as a space for flag 16 (DELPHI only) |
AND 65536 |
Convert case on IBM high-ASCII latin characters (DELPHI only). |
AND 131072+ |
Reserved. |
Edn_*
File: ueditor.pas
Type: constants
Description:
Teditor notification codes.
Mnuemonic |
Value |
Description |
edn_Memory |
1 |
Not enough memory |
edn_Top |
2 |
Backup past BOB |
edn_Bottom |
3 |
Advance beyond EOB |
edn_Length |
4 |
Line length exceeds 255 characters |
edn_NotFound |
5 |
Text not found |
edn_NoSelection |
6 |
Nothing selected |
edn_Selection |
7 |
Selection in progress |
edn_Position |
8 |
Changed cursor position |
edn_Modify |
9 |
Buffer modification flag has changed |
edn_LineCount |
10 |
Line count change |
edn_Scroll |
11 |
Position within buffer change |
edn_Frozen |
12 |
Selection is frozen |
Eds_*
File: ueditor.pas
Type: constants
Description:
Options (styles) for Teditor operation.
Mnuemonic |
Value |
Description |
eds_SubWindow |
1 |
Sub window within window |
eds_ScrollOnRedraw |
2 |
Scroll on redraw of adjustment |
eds_CursorBound |
4 |
Bind cursor to line length |
eds_Beep |
8 |
Beep on warning/error |
eds_AutoIndent |
16 |
Automatically indent new lines |
eds_NoMessages |
32 |
No error/warning messages |
eds_NoTabs |
64 |
No special tab processing |
eds_NoCursorWrap |
128 |
No wrapping of cursor |
eds_Case_Sensitive |
256 |
Case-sensitive searches |
EERT
File: express.pas
Type: string function
Parameters:
Name |
Type |
Description |
X |
Integer |
Code for which to return text. |
Description:
Returns text associated with passed expression error code.
EKC_*
File: tsrs.pas
Type: integer constants
Description:
These constants provide mnemonics for Extended Key Codes that are returned from BIOS calls.
Name |
Value |
Description |
EKC_Alt_0 |
129 |
Alt+0 |
EKC_Alt_1 |
120 |
Alt+1 |
EKC_Alt_2 |
121 |
Alt+2 |
EKC_Alt_3 |
122 |
Alt+3 |
EKC_Alt_4 |
123 |
Alt+4 |
EKC_Alt_5 |
124 |
Alt+5 |
EKC_Alt_6 |
125 |
Alt+6 |
EKC_Alt_7 |
126 |
Alt+7 |
EKC_Alt_8 |
127 |
Alt+8 |
EKC_Alt_9 |
128 |
Alt+9 |
EKC_Alt_A |
30 |
Alt+A |
EKC_Alt_Accent |
$29 |
Alt+` |
EKC_Alt_Apostrophe |
$28 |
Alt+' |
EKC_Alt_B |
48 |
Alt+B |
EKC_Alt_Backslash |
$2B |
Alt+\ |
EKC_Alt_Backspace |
$E |
Alt+Backspace |
EKC_Alt_C |
46 |
Alt+C |
EKC_Alt_Comma |
$33 |
Alt+, |
EKC_Alt_D |
32 |
Alt+D |
EKC_Alt_Delete |
$A3 |
Alt+Delete |
EKC_Alt_Down |
$A0 |
Alt+Down-arrow |
EKC_Alt_E |
18 |
Alt+E |
EKC_Alt_End |
$9F |
Alt+End |
EKC_Alt_Enter |
$1C |
Alt+Enter |
EKC_Alt_Escape |
1 |
Alt+Escape |
EKC_Alt_F |
33 |
Alt+F |
EKC_Alt_F1 |
104 |
Alt+F1 |
EKC_Alt_F10 |
113 |
Alt+F10 |
EKC_Alt_F11 |
$8B |
Alt+F11 |
EKC_Alt_F12 |
$8C |
Alt+F12 |
EKC_Alt_F2 |
105 |
Alt+F2 |
EKC_Alt_F3 |
106 |
Alt+F3 |
EKC_Alt_F4 |
107 |
Alt+F4 |
EKC_Alt_F5 |
108 |
Alt+F5 |
EKC_Alt_F6 |
109 |
Alt+F6 |
EKC_Alt_F7 |
110 |
Alt+F7 |
EKC_Alt_F8 |
111 |
Alt+F8 |
EKC_Alt_F9 |
112 |
Alt+F9 |
EKC_Alt_G |
34 |
Alt+G |
EKC_Alt_Gray_Asterisk |
$37 |
Alt+Gray * |
EKC_Alt_Gray_Dash |
$4A |
Alt+Gray - |
EKC_Alt_Gray_Enter |
$A6 |
Alt+Gray Enter |
EKC_Alt_Gray_Plus |
$90 |
Alt+Gray + |
EKC_Alt_Gray_Slash |
$A4 |
Alt+Gray / |
EKC_Alt_H |
35 |
Alt+H |
EKC_Alt_Home |
119 |
Alt+Home |
EKC_Alt_I |
23 |
Alt+I |
EKC_Alt_Insert |
$A2 |
Alt+Insert |
EKC_Alt_J |
36 |
Alt+J |
EKC_Alt_K |
37 |
Alt+K |
EKC_Alt_L |
38 |
Alt+L |
EKC_Alt_Left |
$9B |
Alt+Left-arrow |
EKC_Alt_Left_Bracket |
$1A |
Alt+[ |
EKC_Alt_M |
50 |
Alt+M |
EKC_Alt_N |
49 |
Alt+N |
EKC_Alt_O |
24 |
Alt+O |
EKC_Alt_P |
25 |
Alt+P |
EKC_Alt_Page_Down |
118 |
Alt+Page Down |
EKC_Alt_Page_Up |
$99 |
Alt+Page Up |
EKC_Alt_Period |
$34 |
Alt+. |
EKC_Alt_Q |
16 |
Alt+Q |
EKC_Alt_R |
19 |
Alt+R |
EKC_Alt_Right |
$9D |
Alt+Right-arrow |
EKC_Alt_Right_Bracket |
$1B |
Alt+] |
EKC_Alt_S |
31 |
Alt+S |
EKC_Alt_Semicolon |
$27 |
Alt+; |
EKC_Alt_Slash |
$35 |
Alt+/ |
EKC_Alt_T |
20 |
Alt+T |
EKC_Alt_Tab |
$A5 |
Alt+Tab |
EKC_Alt_U |
22 |
Alt+U |
EKC_Alt_Up |
$98 |
Alt+Up arrow |
EKC_Alt_V |
47 |
Alt+V |
EKC_Alt_W |
17 |
Alt+W |
EKC_Alt_X |
45 |
Alt+X |
EKC_Alt_Y |
21 |
Alt+Y |
EKC_Alt_Z |
44 |
Alt+Z |
EKC_Alt1 |
130 |
Left Alt |
EKC_Alt2 |
131 |
Right Alt |
EKC_Control_5 |
$8F |
Control+5 |
EKC_Control_Delete |
$93 |
Control+Delete |
EKC_Control_Down |
$91 |
Control+Down arrow |
EKC_Control_End |
117 |
Control+End |
EKC_Control_F1 |
94 |
Control+F1 |
EKC_Control_F10 |
103 |
Control+F10 |
EKC_Control_F11 |
$89 |
Control+F11 |
EKC_Control_F12 |
$8A |
Control+F12 |
EKC_Control_F2 |
95 |
Control+F2 |
EKC_Control_F3 |
96 |
Control+F3 |
EKC_Control_F4 |
97 |
Control+F4 |
EKC_Control_F5 |
98 |
Control+F5 |
EKC_Control_F6 |
99 |
Control+F6 |
EKC_Control_F7 |
100 |
Control+F7 |
EKC_Control_F8 |
101 |
Control+F8 |
EKC_Control_F9 |
102 |
Control+F9 |
EKC_Control_Gray_Asterisk |
$96 |
Control+Gray * |
EKC_Control_Gray_Dash |
$8E |
Control+Gray - |
EKC_Control_Gray_Plus |
$90 |
Control+Gray + |
EKC_Control_Gray_Slash |
$95 |
Control+Gray / |
EKC_Control_Insert |
$92 |
Control+Insert |
EKC_Control_Left |
115 |
Control+Left arrow |
EKC_Control_Right |
116 |
Control+Right arrow |
EKC_Control_Tab |
$94 |
Control+Tab |
EKC_Control_Up |
$8D |
Control+Up arrow |
EKC_Delete |
83 |
Delete |
EKC_Down |
80 |
Down-arrow |
EKC_F1 |
59 |
F1 |
EKC_F10 |
68 |
F10 |
EKC_F11 |
$85 |
F11 |
EKC_F12 |
$86 |
F12 |
EKC_F2 |
60 |
F2 |
EKC_F3 |
61 |
F3 |
EKC_F4 |
62 |
F4 |
EKC_F5 |
63 |
F5 |
EKC_F6 |
64 |
F6 |
EKC_F7 |
65 |
F7 |
EKC_F8 |
66 |
F8 |
EKC_F9 |
67 |
F9 |
EKC_Home |
71 |
Home |
EKC_Insert |
82 |
Insert |
EKC_Left |
75 |
Left-arrow |
EKC_Page_Down |
81 |
Page Down |
EKC_Page_Up |
73 |
Page Up |
EKC_Right |
77 |
Right-arrow |
EKC_Shift_F1 |
84 |
Shift+F1 |
EKC_Shift_F10 |
93 |
Shift+F10 |
EKC_Shift_F11 |
$87 |
Shift+F11 |
EKC_Shift_F12 |
$88 |
Shift+F12 |
EKC_Shift_F2 |
85 |
Shift+F2 |
EKC_Shift_F3 |
86 |
Shift+F3 |
EKC_Shift_F4 |
87 |
Shift+F4 |
EKC_Shift_F5 |
88 |
Shift+F5 |
EKC_Shift_F6 |
89 |
Shift+F6 |
EKC_Shift_F7 |
90 |
Shift+F7 |
EKC_Shift_F8 |
91 |
Shift+F8 |
EKC_Shift_F9 |
92 |
Shift+F9 |
EKC_Shift_Tab |
15 |
Shift+Tab |
EKC_Up |
72 |
Up-arrow |
EM
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 25 (End of Medium).
End_Edit
File: teu.c
Type: void function
Parameters: None
Description:
Terminates the TEU editing session.
End_SMU
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters: None
Description:
Shuts down SMU processing. No further SMU functions should be called until Init_SMU is called.
ENQ
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 5 (Enquiry).
EOT
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 4 (End Of Transmission).
EPA
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 151.
Erase_Eol
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Name |
Type |
Description |
Window_P |
Pwindow |
SMU window to modify. |
Description:
This function erases from the current cursor position to the end of the line.
Erase_Eow
File: smu.c
Type: void function
Parameters:
Name |
Type |
Description |
Window_P |
Pwindow |
SMU window to modify. |
Description:
This function erases from the current cursor position to the end of the window.
Error
File: standard.pas
Type: procedure
Parameters: None
Description:
This procedure handles errors by displaying the error and calling any other error handlers.
Error_Code
File: errmastr.pas
Type: double function (Pascal), TUEC function (Delphi)
Parameters:
Parameter |
Type |
Description |
Facility |
Longint |
Facility code. |
Code |
Longint |
Error code. |
Description:
Returns a TUEC containing the passed facility and error codes. Note that the return is packed into a double-precision real in Pascal due to the inability to return records.
ERT
File: standard.pas, standard.c
Type: string function (Pascal), char* function (C)
Parameters:
Parameter |
Type |
Description |
Err |
Integer (int) |
The DOS error code for which to return the string. |
Description:
Returns the text associated with the passed DOS error code.
ESA
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 135.
ESC
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 27 (Escape).
ETB
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 23 (End Transmission Block).
ETX
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 3 (End Text).
Eval
File: express.pas
Type: procedure
Parameters:
Name |
Type |
Description |
Expression |
String |
Expression to evaluate. |
_Result |
Var extended |
Ignored on call. The resulting value on return. |
Imaginary |
Var extended |
Reserved for future use. |
E |
Var integer |
Error code (0 if none). Use EERT to get text associated with this error. |
P |
Var integer |
Position of error, if one, in Expression. |
Description:
Evaluates an expression and returns the results. See the desription of Texpression_Evaluator for a list of built-in operators, functions, and constants.
Exec
File: compatib.pas
Type: procedure (Delphi, Pascal - Windows)
Parameters:
Parameter |
Type |
Description |
Path |
String |
Path and name of program to execute. |
Parameters |
String |
Parameters to pass to program. |
Description:
ASCII code 3 (End Text).
Execute_Command
File: teu.c
Type: procedure (Delphi, Pascal - Windows)
Parameters:
Parameter |
Type |
Description |
Passed_Command |
char* |
TEU Command to execute. |
Description:
Executes a TEU command.
ExitSave
File: standard.pas
Type: pointer
Description:
This variable holds the next error procedure to call on program exit.
Explicit
File: files.pas
Type: string function
Parameters:
Name |
Type |
Description |
X |
string |
Specification to process. |
Description:
This function returns the passed file specification, with all relative pathing removed, and device and full path added. No processing occurs if the specification begins with two backslashes.
Extension_Pos
File: standard.pas, standard.c
Type: integer function (Pascal), int function (C)
Parameters:
Parameter |
Type |
Description |
X |
String |
Filename for which to return position of extension. |
Description:
This function returns the position of the dot (".") of the file extension. It returns 0 if no extension is present.
Extract
File: extract.asm
Type: routine
Parameters:
Register |
Description |
CL |
Starting position in WorkBuff (0 is first position). |
Description:
This routine copies characters from Workbuff, placing them in Inbuf and setting the length of Inbuf. This is equivalent to a BASIC Right() function.
Extract
File: ustrings.asm
Type: string function
Parameters:
Name |
Type |
Description |
Original |
String |
String to extract from. |
Substring |
String |
String to extract from Original. |
Start |
Integer |
Starting position. |
Ending |
integer |
Ending position. |
Description:
This function returns the passed Original string, with all instances of the specified substring between Start and Ending removed.
Facility_Count
File: errmastr.pas
Type: longint function
Description:
Returns the number of registered error interfaces.
Facility_From_Index
File: errmastr.pas
Type: longint function
Parameters:
Parameter |
Type |
Description |
Index |
Longint |
Index into list of registered error interfaces. |
Description:
Returns the facility code for the specified registered error interface.
Facility_Name_From_Index
File: errmastr.pas
Type: PChar function
Parameters:
Parameter |
Type |
Description |
Index |
longint |
Index into list of registered error interfaces. |
Description:
Returns the name of the facility for the specified registered error interface.
File: maths.pas
Type: extended function
Parameters:
Name |
Type |
Description |
X |
extended |
Value for which to return factorial. |
Description:
Returns the factorial for the passed value.
faDirectory
File: compatib.pas
Type: constant (Delphi)
Description:
Equivalent to SysUtils.faDirectory.
FEdit
File: standard.pas
Type: procedure
Parameters:
Parameter |
Type |
Description |
Dst |
String |
Result string. |
Src |
String |
String to copy to Dst with edits. |
Flags |
Longint |
Editing option flags. |
Description:
This procedure performs the same function as Edit, except that the result is placed in Dst. Edit should be used instead. See Edit for details on the flags.
FF
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 12 (Form Feed).
Fib
File: maths.pas
Parameters:
Name |
Type |
Description |
X |
extended |
Value for which to return Fibonacci number. |
Description:
Returns Fibonacci number for passed value.
FileExists
File: compatib.pas
Type: boolean function
Parameters:
Parameter |
Type |
Description |
S |
String |
Full filename of file to check. |
Description:
Returns True if the specified file exists.
FileGetAttr
File: compatib.pas
Type: integer function
Parameters:
Parameter |
Type |
Description |
S |
String |
Full filename of file to check. |
Description:
Returns the attributes of the specified file.
FileGetTime
File: compatib.pas
Type: longint function
Parameters:
Parameter |
Type |
Description |
S |
String |
Full filename of file to check. |
Description:
Returns the file date for the specified file.
FileName
File: files.pas
Type: string function
Parameters:
Name |
Type |
Description |
X |
String |
File specification of file to find. |
Description:
Find a file given a file name. The specification can contain logicals (symbols), and search lists (;). If no device/directory is specified and file is not found with name given, it is searched for in PATH:. Literal devices are specified with underscores (_). If a logical translation fails, the "logical" is tried as if a literal device name. If no file is found, the passed name, with translated logicals, is returned.
FileRec
File: files.pas
Type: type (Delphi)
Description:
Synonymous with TfileRec.
Filled_Polygon
File: lines.pas
Type: procedure (Delphi)
Parameters:
Name |
Type |
Description |
C |
Tcanvas |
Canvas on which to draw. |
Points |
Array of TPoint |
Open array of points defining polygon. A line is drawn between each adjacent point. The first and last points are considered adjacent. |
Description:
Draws a filled polygon on the canvas, using the current pen color for that canvas.
Filnam
File: files.pas, files.c
Type: string function (Pascal), char* function (C)
Parameters:
Name |
Type |
Description |
X |
Const string |
File specification of file to find. |
Description:
Find a file given a file name. The specification can contain logicals (symbols), and search lists (;). If no device/directory is specified and file is not found with name given, it is searched for in PATH:. Literal devices are specified with underscores (_). If a logical translation fails, the "logical" is tried as if a literal device name. If no file is found, the function returns a null string.
File_Split
File: compatib.pas
Type: procedure
Parameters:
Parameter |
Type |
Description |
Nam |
string |
Filename to split into component parts. |
S1 |
Var string |
Ignored when passed. The device and path on return. |
S2 |
Var string |
Ignored when passed. The name on return. |
S3 |
Var string |
Ignored when passed. The extension on return. |
Description:
This function breaks the specified filename into its component parts.
FindFirst
File: compatib.pas
Type: integer function
Parameters:
Parameter |
Type |
Description |
S |
String |
File lookup specification (including wildcards). |
Flags |
Integer |
Lookup flags. |
File_Stuff |
Var TSearchRec |
Ignored when passed. The context to pass to subsequent FindNext calls. |
Description:
Finds the first file matching the passed specification. See also FindNext.
FindNext
File: compatib.pas
Type: integer function
Parameters:
Parameter |
Type |
Description |
File_Stuff |
Var TSearchRec |
Context from original FindFirst call. |
Description:
Finds the next matching file. See also FindFirst.
Flag_Changes
File: teu.c
Type: void function
Parameters: None
Description:
Marks the current edit line as having been modified.
Format_Time
File: dates.pas
Type: string function
Parameters:
Parameter |
Type |
Description |
||
Format |
String |
Formatting string. See description. If this is null, the default formatting is ‘DDDHHHMM:SS.1' |
||
Days |
integer |
Number of days. |
||
Hours |
Integer |
Number of hours. |
||
Minutes |
Integer |
Number of minutes. |
||
Seconds |
Integer |
Number of seconds. |
||
Hundreths |
Integer |
Number of 1/100 seconds. |
Description:
This function formats the passed time information according to the passed formatting string and returns the result. The formatting string contains values which are translated into time values according to the following rules. Any characters in the formatting string which do not appear in the following list are left as they are.
Specification |
Translation |
A |
"a" if am, "p" if pm. |
AA |
"am" or "pm". This ensures the hour is within the range 1-12. |
AAA |
"A". |
1 |
Hundreths of seconds ("0" to "99"). |
11 |
Hundreths of seconds ("00" to "99"). |
111 |
Hundreths of seconds with decimal (".1" to ".99"). Blank if Hundreths is 0. |
1111 |
Hundreths of seconds with decimal (".01" to ".99"). Blank if Hundreths is 0. |
11111 |
"1". |
S |
Seconds ("0" to "59"). |
SS |
Seconds ("00" to "59"). |
SSS |
Seconds with colon (":0" to ":59"). |
SSSS |
Seconds with colon (":00" to ":59"). |
SSSSS |
"S". |
M |
Minutes ("0" to "59"). |
MM |
Minutes ("00" to "59"). |
MMM |
Minutes with colon (":0" to ":59"). |
MMMM |
Minutes with colon (":00" to ":59"). |
MMMMM |
"M". |
H |
Hours ("0" to "23"). If "A" or "AA" are used, this is "1" to "12". |
HH |
Hours ("00" to "23"). If "A" or "AA" are used, this is "01" to "12". |
HHH |
Hours with colon (":0" to ":23"). If "A" or "AA" are used, this is ":1" to ":12"). |
HHHH |
Hours with colon (":00" to ":23"). If "A" or "AA" are used, this is ":01" to ":12"). |
HHHHH |
"H". |
D |
Days ("0" to "9999"). |
DD |
Days ("00" to "9999"). |
DDD |
Days ("000" to "9999"). |
DDDD |
Days ("0000" to "9999"). |
Format_Date
File: dates.pas
Type: string function
Parameters:
Parameter |
Type |
Description |
||
Format |
String |
Formatting string. See description. If this is null, the default formatting is ‘DD-MMM-YYYY' |
||
|
||||
Year |
Integer |
Year (eg 1987). |
||
Month |
Integer |
Month ordinal (1 = January, 12 = December). |
||
Day |
Integer |
Day of month (1-31). |
Description:
This function formats the passed date information according to the passed formatting string and returns the result. The formatting string contains values which are translated into date values according to the following rules. Any characters in the formatting string which do not appear in the following list are left as they are.
Specification |
Translation |
C |
“BC” or “AD” |
CC |
“C” |
D |
Day (1-31). |
DD |
Two-digit day (01-31). |
DDD |
“D” |
M |
Month (1-12). |
MM |
Two-digit month (01-12). |
MMM |
Month name abbreviation (Jan, Feb, Mar, etc). |
MMMM |
Full month name (January, February, etc). |
MMMMM |
“M” |
Y |
Year. |
YY |
Two-digit year (00-99). |
YYY |
“Y” |
YYYY |
Four-digit year (0000-9999). |
Free_Cache
File: cache.c
Type: void function
Parameters:
Parameter |
Type |
Description |
Siz |
long int |
Amount of space to free, in bytes. |
Priority |
long int |
Priority of request. No cache with a higher priority will be requested to free memory. |
Exclude |
void (*Exclude)(int, int) |
A cache handler to exclude from the request. This can be NULL, but is most likely the cache handler associated with the cache that is requesting that some memory be freed. |
Description:
This routine can be called when memory is low and some needs to be deallocated. Calling this with a Siz of -1, a Priority of maxint, and an Exclude of NULL will free ALL memory associated with registered caches.
Format
File: teu.c
Type: void function
Parameters:
Parameter |
Type |
Description |
X |
char* |
Text to format. |
Description:
This function formats the passed text, handing tabs, and non-text ASCII values.
Free_Cache
File: cache.pas
Type: procedure
Parameters:
Parameter |
Type |
Description |
Siz |
Longint |
Amount of space to free, in bytes. |
Priority |
Longint |
Priority of request. No cache with a higher priority will be requested to free memory. |
Exclude |
Tcache_handler |
A cache handler to exclude from the request. This can be nil, but is most likely the cache handler associated with the cache that is requesting that some memory be freed. |
Description:
This routine can be called when memory is low and some needs to be deallocated.
FRight
File: ustrings.pas, ustrings.c
Type: procedure (Pascal), void (C)
Parameters:
Name |
Type |
Description |
Z |
Var String |
Ignored on call. The copy of C on return. |
C |
Var String |
String to copy. |
Position |
Integer |
Position to begin copy. |
Description:
Copies the right part of the passed string, starting at the specified position, to the destination string.
FS
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 28 (Form Separator).
FSF_*
File: files.pas
Type: Constants
Description:
These constants define File System Flags used in opening a Tfile_System:
Mnuemonic |
Value |
Description |
FSF_Fixed_Size |
1 |
The file system is on a fixed-size device. |
FSF_Read_Only |
2 |
The file system is opened in read-only mode. |
FSF_NoOwnStore |
4 |
The file system doesn't own the store - so don't close it when the file system object is destructed. |
FSFF_*
File: files.pas
Type: Constants
Description:
These constants define the file system file flags (flags stored in the file system about the file). Note that not all file systems support all flags.
Mnemonic |
Value |
Description |
FSFF_Directory |
1 |
A directory. |
FSFF_Journaling |
2 |
A journalled file. |
FSFF_File_System |
4 |
A file-system file. |
FSFF_Compressed |
8 |
A compressed file. |
FSFF_Erase |
16 |
Erase file upon deletion. |
FSFF_Statistics |
32 |
Keep file access statistics. |
FSFF_Read_Verify |
64 |
Verify read accesses. |
FSFF_Write_Verify |
128 |
Verify write accesses. |
FSFF_Hidden |
256 |
A hidden file. |
FSFF_Contiguous |
512 |
File is contiguous on file system device. |
FSFF_Deleted |
1024 |
File is deleted but still open (marked for deletion). |
FSFF_Protected |
2048 |
DOS protected. |
FSFF_System |
4096 |
DOS system file. |
FSFF_VolumeID |
8192 |
DOS label. |
FSFF_Archive |
16384 |
DOS archive flag. |
FSOM_*
File: files.pas
Type: Constants
Description:
These constants are used to define how files are opened (Open Mode):
Mnuemonic |
Value |
Description |
FSOM_Append |
1 |
Append mode (file must already exist). |
FSOM_Input |
2 |
File must already exist. |
FSOM_Output |
3 |
File is created (deleted if existing). |
FSOM_Text |
4 |
File is text mode. |
FSOM_Read_Only |
8 |
File cannot be written to. |
FSOM_Share_Read |
16 |
File can be opened read-only by others. |
FSOM_Share_Write |
32 |
File can be opened writable by others. |
GCD
Type: longint function
Parameters:
Name |
Type |
Description |
N |
longint |
Numerator |
D |
longint |
Denominator |
Description:
Returns the greatest common divsor for the passed values.
Get_Char
File: getchars.c
Type: char function
Parameters:
Name |
Type |
Description |
Option |
Int |
If 0, the function doesn't return until input is available. Otherwise, it returns immediately. In the second case, it returns a NUL (ASCII 0) if no input is available. |
Description:
This function returns a single character from the keyboard.
Get_Default_Window
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Name |
Type |
Description |
X |
Var window_record |
Ignored on call. The default SMU window on return. |
Description:
This function returns the current default SMU window.
Get_Error_Text
File: errmastr.pas
Type: Pchar function
Parameters:
Parameter |
Type |
Description |
UEC |
TUEC |
UEC for which to return text. |
Level |
longint |
Severity level indicator to include in text: -1 = Include default severity of the passed UEC |
Description:
This function returns the text associated with the passed UEC. The text has the format:
Severity Error-Code: Facility-name – Error-text
where Severity is a severity code ("Error", "Warning", etc), Error-Code is the numeric error code, Facility-name is the name of the facility (or number if no error interface was registered for this facility), and Error-text is the text of the error.
Get_Error_Text_Ex
File: errmastr.pas
Type: Pchar function
Parameters:
Parameter |
Type |
Description |
UEC |
TUEC |
UEC for which to return text. |
Level |
longint |
Severity level indicator to include in text: -1 = Include default severity of the passed UEC |
Var Size |
Longint |
Ignored when passed, the length of the error text upon return. |
Var Type |
longint |
Ignored when passed, the type of the error text upon return: 0 = 7-bit ASCII |
Description:
This function returns the text associated with the passed UEC. The text has the format:
Severity Error-Code: Facility-name – Error-text
where Severity is a severity code ("Error", "Warning", etc), Error-Code is the numeric error code, Facility-name is the name of the facility (or number if no error interface was registered for this facility), and Error-text is the text of the error.
Get_Model
File: smu.c, smu.pas
Type: int function (C), byte function (Pascal)
Parameters: None
Description:
This function returns the computer hardware model SMU ID.
Get_Screen
File: smu.c, smu.pas
Type: char function (C), byte function (Pascal)
Parameters:
Name |
Type |
Description |
Row |
Integer |
Screen row. |
Col |
Integer |
Screen column. |
Description:
This function returns the character that is displayed at the specified screen location.
_Get_Screen
File: smubios.pas
Type: byte function
Parameters:
Name |
Type |
Description |
Row |
Integer |
Screen row. |
Col |
Integer |
Screen column. |
Default |
Byte |
If the specified location is undefined, return this value. |
Description:
This function returns the character that is displayed at the specified screen location.
Get_Serial_Number
File: standard.pas
Type: longint function
Parameters: None
Description:
This function returns a unique one-up number. Each call to this function returns a different value. This can be used to obtain serial numbers.
Get_Temp_File_Name
File: files.pas
Type: string function
Parameters:
Name |
Type |
Description |
Prefix |
Const string |
Filename prefix to use. |
Description:
Returns a temporary file name.
Get_Text_Extent
File: smu.pas
Type: longint function
Parameters:
Name |
Type |
Description |
Window |
PWindow |
Window in which context to get text size. |
String_P |
String |
String to return size of. |
Count |
Integer |
Size of passed string, in bytes. |
Description:
Returns the size of the passed string. Height is returned in the high-order word and Width is in the low-order word.
Get_Web_File
File: Internet_Util.pas
Type: string function
Parameters:
Name |
Type |
Description |
Name |
string |
The URL of the file to retrieve. |
Description:
This function returns the contents of the file at the passed URL. Note: this only supports HTTP: file access (that is, the URL must begin with "http://").
Get_Window_Attribute
File: smu.c, smu.pas
Type: int function (C), byte function (Pascal)
Parameters:
Name |
Type |
Description |
R |
Integer |
Row on SMU window. |
C |
Integer |
Column on SMU window. |
Description:
Returns the display attributes for the specified location in the default window.
Get_Window_Char
File: smu.c, smu.pas
Type: char function (C), byte function (Pascal)
Parameters:
Name |
Type |
Description |
R |
Integer |
Window row. |
C |
Integer |
Window column. |
Description:
This function returns the character that is displayed at the specified SMU window location.
GetCurDir
File: compatib.pas
Type: procedure (Delphi)
Parameters:
Parameter |
Type |
Description |
X |
Pchar |
Ignored when called, the current path on return. |
Y |
Integer |
This parameter is ignored. It is present for compatibility with Borland Pascal. |
Description:
This procedure returns the current path.
GetDate
File: compatib.pas
Type: procedure (Delphi)
Parameters:
Parameter |
Type |
Description |
Year |
Var Word |
Ignored when called, the year on return. |
Month |
Var Word |
Ignored on call, the month on return (1-12). |
Day |
Var Word |
Ignored on call, the day of month on return (1-31). |
DayofWeek |
Var Word |
Ignored on call, the day of the week on return. |
Description:
This procedure returns the current date.
GetEnv
File: compatib.pas
Type: String function (Delphi, Borland Pascal - Windows)
Parameters:
Parameter |
Type |
Description |
X |
String |
Environment variable to return |
Description:
This function returns the value of the environment variable whose name is passed. If the variable does not exist, an empty string is returned.
GetTextExtent
File: smu.pas
Type: longint function
Parameters:
Name |
Type |
Description |
Window |
PWindow |
Window in which context to get text size. |
String_P |
PChar |
String to return size of. |
Count |
Integer |
Size of passed string, in bytes. |
Description:
Returns the size of the passed string. Height is returned in the high-order word and Width is in the low-order word.
GetTime
File: compatib.pas
Type: procedure (Delphi)
Parameters:
Parameter |
Type |
Description |
Hour |
Var word |
Ignored when called, the hour on return. |
Minute |
Var word |
Ignored when called, the minute on return. |
Second |
Var word |
Ignored when called, the second on return. |
Sec100 |
Var word |
Ignored when called, the time in 1/100 seconds within Second. |
Description:
Returns the current time of day.
GS
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 29 (Group Separator).
Handle_Selection
File: teu.c
Type: void function
Parameters:
Name |
Type |
Description |
Cursor_Row |
short int |
Row of cursor. |
Physical_Column |
short int |
Physical column of cursor. |
Physical_Text |
char* |
Unformatted text. |
Description:
Properly applies highlighting to text based on passed parameters.
Help
File: help.c, helps.pas
Type: void function (C), procedure (Pascal)
Parameters:
Name |
Type |
Description |
Command |
String |
Name of help file. |
Command1 |
String |
Starting top-level help topic name. |
Description:
Displays hierarchical plain-text help.
HInstance
File: compatib.pas
Type: constant (Borland Pascal)
Description:
Constant value of 0.
HT
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 9 (Horizontal Tab).
HTJ
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 137.
HTS
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 136.
HypArcCos
File: maths.pas
Type: extended function
Parameters:
Name |
Type |
Description |
|
extended |
Value for which to return hyperbolic arc cosine. |
Description:
Returns Hyperbolic Arc Cosine of passed value.
HypArcCoT
File: maths.pas
Type: extended function
Parameters:
|
Type |
Description |
X |
extended |
Value for which to return hyperbolic arc cotangent. |
Description:
Returns Hyperbolic Arc Cotangent of passed value.
HypArcCsc
File: maths.pas
Type: extended function
Parameters:
Name |
Type |
Description |
|
extended |
Value for which to return hyperbolic arc cosecant. |
Description:
Returns Hyperbolic Arc Cosecant of passed value.
HypArcSec
File: maths.pas
Type: extended function
Parameters:
|
Type |
Description |
X |
extended |
Value for which to return hyperbolic arc secant. |
Description:
Returns Hyperbolic Arc Secant of passed value.
HypArcSin
File: maths.pas
Parameters:
Name |
Type |
Description |
X |
extended |
Value for which to return hyperbolic arc sine. |
Description:
Returns Hyperbolic Arc Sine of passed value.
HypArcTan
Type: extended function
Parameters:
Name |
Type |
Description |
X |
extended |
Value for which to return Hyperbolic Arc Tangent. |
Description:
Returns Hyperbolic Arc Tangent of passed value.
HypCos
File: maths.pas
Type: extended function
Parameters:
Name |
Type |
Description |
X |
extended |
Value for which to return hyperbolic cosine. |
Description:
Returns Hyperbolic Cosine of passed value.
HypCoT
File: maths.pas
Type: extended function
Parameters:
|
Type |
Description |
|
extended |
Value for which to return hyperbolic cotangent. |
Description:
Returns Hyperbolic Cotangent of passed value.
HypCSc
File: maths.pas
Type: extended function
Parameters:
|
Type |
Description |
X |
extended |
Value for which to return hyperbolic cosecant. |
Description:
Returns Hyperbolic Cosecant of passed value.
HypSec
File: maths.pas
Type: extended function
Parameters:
Name |
Type |
Description |
X |
extended |
Value for which to return hyperbolic secant. |
Description:
Returns Hyperbolic secant of passed value.
HypSin
File: maths.pas
Type: extended function
Parameters:
Name |
Type |
Description |
X |
extended |
Value for which to return hyperbolic sine. |
Description:
Returns Hyperbolic Sine of passed value.
HypTan
File: maths.pas
Type: extended function
Parameters:
|
Type |
Description |
X |
extended |
Value for which to return hyperbolic tangent. |
Description:
Returns Hyperbolic Tangent of passed value.
IBM_Pos
File: smubios.pas
Type: procedure
Parameters:
Name |
Type |
Description |
X |
Integer |
Screen row. |
Y |
integer |
Screen column. |
Description:
Positions the cursor to the specified location.
InBLen
File: io.asm
Type: DB
Description:
Length of data in InBuff, in bytes.
InBuff
File: io.asm
Type: DB 256 DUP (0)
Description:
Buffer used to store keyboard input for assembly I/O routines.
IND
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 132.
Init_Smu
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Name |
Type |
Description |
X |
int |
Pass 0 for default. |
Y |
int |
Pass 0 for default. |
Z |
int |
Pass 0 for default. |
A |
int |
Pass 0 for default. |
Description:
Initializes SMU. No SMU functions should be called prior to this function call.
InKey
File: getchars.c
Type: char* function
Parameters: None
Description:
Reads a single keystroke from the keyboard and returns it. In the case of normal keys, a single byte string is returned. In the case of special keys, one of the following strings is returned:
Value Return |
Key(s) Pressed |
"A" followed by any single character |
ALT, and the second character indicates the other key pressed. For instance, "AH" indicates ALT and the "H" key. |
CKP1 |
CTRL and keypad 1 |
CKP3 |
CTRL and keypad 3 |
CKP4 |
CTRL and keypad 4 |
CKP6 |
CTRL and keypad 6 |
CKP7 |
CTRL and keypad 7 |
CKP9 |
CTRL and keypad 9 |
UP |
Up-arrow |
DOWN |
Down-arrow |
RIGHT |
Right-arrow |
LEFT |
Left-arrow |
DELETE |
DELETE |
BACK |
BACKSPACE |
INSERT |
INSERT |
HOME |
HOME |
END |
END |
KP0 |
Keypad 0 (DEC keyboard only) |
KP1 |
Keypad 1 (DEC keyboard only) |
KP2 |
Keypad 2 (DEC keyboard only) |
KP3 |
Keypad 3 |
KP4 |
Keypad 4 (DEC keyboard only) |
KP5 |
Keypad 5 (DEC keyboard only) |
KP6 |
Keypad 6 (DEC keyboard only) |
KP7 |
Keypad 7 (DEC keyboard only) |
KP8 |
Keypad 8 (DEC keyboard only) |
KP9 |
Keypad 9 |
KP, |
Keypad , (DEC keyboard) |
KP. |
Keypad . (DEC keyboard only) |
KP- |
Keypad - (DEC keyboard only) |
PF1 |
PF1 (DEC keyboards) |
PF2 |
PF2 (DEC keyboards) |
PF3 |
PF3 (DEC keyboards) |
PF4 |
PF4 (DEC keyboards) |
ENTER |
Gray ENTER (DEC keyboard only) |
COMPOSE |
COMPOSE (DEC keyboard only) |
F1 |
F1 |
F2 |
F2 |
F3 |
F3 |
F4 |
F4 |
F5 |
F5 |
F6 |
F6 |
F7 |
F7 |
F8 |
F8 |
F9 |
F9 |
F10 |
F10 |
F11 |
F11 |
F12 |
F12 |
F14 |
F14 (DEC keyboard only) |
F15 |
F15 (DEC keyboard only) |
F16 |
F16 (DEC keyboard only) |
F17 |
F17 (DEC keyboard only) |
F18 |
F18 (DEC keyboard only) |
F19 |
F19 (DEC keyboard only) |
F20 |
F20 (DEC keyboard only) |
E1 |
SHIFT F1 |
E2 |
SHIFT F2 |
E3 |
SHIFT F3 |
E4 |
SHIFT F4 |
E5 |
SHIFT F5 |
E6 |
SHIFT F6 |
E7 |
SHIFT F7 |
E8 |
SHIFT F8 |
E9 |
SHIFT F9 |
E10 |
SHIFT F10 |
E11 |
SHIFT F11 |
E12 |
SHIFT F12 |
E13 |
SHIFT F13 |
E14 |
SHIFT F14 |
E15 |
SHIFT F15 |
E16 |
SHIFT F16 |
E17 |
SHIFT F17 |
E18 |
SHIFT F18 |
E19 |
SHIFT F19 |
E20 |
SHIFT F20 |
In_Key
File: teu.c
Type: char* function
Parameters: None
Description:
Retrieves a single key from the keyboard.
Include_File
File: teu.c
Type: void function
Parameters:
Name |
Type |
Description |
Passed_Command |
char* |
Name of file to read. |
Last_Line |
long int* |
Ignored when passed. On return, the function fills this variable with the number of lines read. |
File_Root |
Line_Record** |
Ignored when passed. On return, the function fills this variable with the root of the created buffer. |
File_Last |
Line_Record** |
Ignored when passed. On return, the function fills this variable with a pointer to the last line read. |
Description:
Creates a text buffer and reads text from the specified file into the buffer.
Initialize_File_System
File: files.pas
Type: procedure
Parameters:
Name |
Type |
Description |
Nam |
String |
Device on which to initialize a file system. |
ID |
String |
ID label for file system. |
Flags |
Longint |
1 = Force fixed size. |
UEC |
Var TUEC |
Ignored on call. The condition code on return. |
Description:
Initialize a file system on the device specified.
Initialize_Find_Record
File: files.pas
Type: procedure
Parameters:
Name |
Type |
Description |
F |
Tfind_Record |
Record to initialize. |
Description:
Initializes a Tfind_Record for use in subsequent Lookup function calls.
Input
File: input.asm
Type: routine
Parameters: None
Description:
This routine takes input from the keyboard and stores it in InBuff. LF, CR, FF, VT, and ESC are all treated as delimiters. BEL rings the bell. All other control characters are echoed as "^x". No registers are modified upon return from this routine.
Instr
File: instrs.pas, instr.c
Type: integer function (Pascal), int function (C)
Parameters:
Name |
Type |
Description |
Position |
Integer |
Starting position to begin search for sub-string. |
String |
String |
String in which to search. |
Search_String |
String |
String to search for. |
Description:
Returns the index of a sub string within another string. If the sub string is not found, the function returns 0.
Insert_Chars
File: teu.c
Type: void function
Parameters:
Name |
Type |
Description |
Character |
char* |
Text to insert. |
Description:
Inserts the passed text into the current position in the main TEU buffer.
Insert_Line
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Name |
Type |
Description |
Window_P |
Pwindow |
SMU window to modify. |
Direction |
Byte |
Indicates the direction of scrolling to make room for the new line. 0 = up (lose top line), 1 = down (lose bottom line). |
Description:
Inserts a new line at the current cursor line.
Instr
File: instr.asm
Type: routine
Parameters:
Register |
Description |
AL |
Character to search for within string. |
CX |
Position to begin search within string on entry. The position of the found character (0 if not found). |
Description:
Returns the index of a character within the string in WorkBuff.
Int64
File: typedefs.pas
Type: type (Borland Pascal)
Description:
Equivalent to Comp.
Intr
File: compatib.pas
Type: procedure (Borland Pascal)
Parameters:
Parameter |
Type |
Description |
I |
Byte |
Interrupt number to invoke. |
R |
TRegisters |
Registers to pass to interrupt routine. |
Description:
Makes an interrupt call.
ISgn
File: maths.pas, maths.c
Type: integer function (Pascal), int function (C)
Parameters:
Parameter |
Type |
Description |
X |
Longint |
Value whose sign is to be returned. |
Description:
If X < 0, the function returns -1. If X > 0, the function returns 1. If X = 0, the function returns 0.
INum
File: num1s.pas
Type: string function
Parameters:
Parameter |
Type |
Description |
Variable |
Real |
Value to convert. |
Description:
This function takes a number and returns a string, consisting of the number passed, without the fractional portion.
Invalidate_Window
File: smu.pas
Type: string function
Parameters:
Parameter |
Type |
Description |
Window_P |
PWindow |
Value to convert. |
Description:
Invalidates the window so it will refresh.
Julian
File: dates.pas
Type: integer function
Parameters:
Parameter |
Type |
Description |
M |
Integer |
Month (1-12). |
D |
Integer |
Day (1-31). |
Y |
Integer |
Year. |
Description:
Returns Julian date (day of the year) for the passed date. Note that the passed values are not validated, so passing an incorrect date will return invalid results.
Kb_Buffer
File: smu.c, smu.pas
Type: char [256 ] (C), string (Pascal)
Description:
This buffer contains the pending keyboard input for SMU.
KBFlags
File: io.asm
Type: DB
Description:
Flags used for assembly I/O routines. Flags:
Flag |
Description |
And 1 |
Output is suspended (Xoffed). |
Last_Error
File: errmastr.pas
Type: PChar function
Desciption:
This function returns the text of the last error returned by Get_Error_Text or Get_Error_Text_Ex.
Left
File: ustrings.c
Type: char* function
Parameters:
Parameter |
Type |
Description |
S |
Char* |
String to copy from. |
X |
Int |
Number of characters to copy. |
Description:
This function returns the first X characters of S. If X is greater than the length of S, the entire string is returned. If X is less than 1, a null string is returned.
Leap_Year
File: dates.pas
Type: integer function
Parameters:
Parameter |
Type |
Description |
Year |
Longint |
Year for which to determine leap-year status. |
Description:
This function returns 1 if the passed year is a leap year, and 0 otherwise.
LF
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 10 (Line Feed).
Line_Number_Dialog
File: Linenumb.pas
Type: TLine_Number_Dialog
Description:
The global line number dialog.
Line_Overhead
File: ueditor.pas
Type: integer constant
Description:
ASCII code 10 (Line Feed).
Line_Pointer
File: ueditor.pas
Type: Type (pointer)
Description:
The amount of overhead, in bytes, for each line in the editor buffer.
Line_Record
File: teu.h, ueditor.pas
Type: struct (C), record (Pascal)
Fields:
Name |
Type |
Description |
Last_Line |
Line_Pointer |
Previous line in buffer. NULL means this is the first line. |
Next_Line |
Line_Pointer |
Next line in buffer. NULL means this is the last line. |
Text |
Small_String |
Text of the line. |
Description:
This record is part of a linked list of text lines.
Load_Driver
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Name |
Type |
Description |
X |
Stirng |
Filename of driver. |
Description:
Loads a video driver from the specified binary file into memory and starts the driver.
Log10
File: maths.pas
Type: extended function
Parameters:
Name |
Type |
Description |
X |
Extended |
Value for which to return the logarithm. |
Description:
Return logarithm, base 10.
Log_Error
File: errmastr.pas
Type: procedure
Parameters:
Parameter |
Type |
Description |
UEC |
TUEC |
UEC of error to log. |
T |
String |
Text of error to log. |
Level |
longint |
Severity level of error. |
Description:
This procedure logs an error to the default system output device (text in DOS, message box in Windows). See Set_Master_Error_Operation for information on how this function behaves.
Lookup
File: wildcard.c
Type: char* function
Parameters:
Name |
Type |
Description |
Passed_Filename |
char* |
File specification to lookup on first call. On subsequent calls for the same lookup, this is a null string. |
Description:
This function is used to perform wildcard file lookups. This function uses the same wildcard rules as WC_Match.
Lookup
File: files.pas
Type: string function
Parameters:
Name |
Type |
Description |
Filename |
String |
File specification to lookup on first call. On subsequent calls for the same lookup, this is null. |
Find_record |
var Tfind_Record |
Context for lookup. |
Description:
This function is used to perform wildcard file lookups. This function uses the same wildcard rules as WC_Match.
Map_Window
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Name |
Type |
Description |
Window_P |
Pwindow |
SMU window to map. |
Row |
Byte |
Screen row to which to map top of window. |
Row_Count |
Byte |
Number of rows to map. |
Column |
Byte |
Screen column to which to map left of window. |
Column_Count |
Byte |
Number of columns to map. |
View_R |
Byte |
Topmost row of window to map. |
View_C |
Byte |
Leftmost column of window to map. |
Level |
Byte |
Level of window (Z-order). |
Description:
This function maps an SMU window to the specified location on the screen. The window cannot overlap any other windows with the same Level on the screen.
MaxAvail
File: standard.pas
Type: longint constant (Delphi)
Description:
Returns the maximum amount of heap space available.
MaxAvail
File: compatib.pas
Type: longint function (Delphi)
Description:
Returns the maximum amount of heap space available.
MemAvail
File: compatib.pas
Type: longint function (Delphi)
Description:
Returns the size of the largest chunk of heap space available.
Max_File_Size
File: typedefs.pas
Type: longint constant (Pascal)
Description:
Defines the maximum file size, in bytes.
Max_Memory
File: typedefs.pas
Type: longint constant (Pascal)
Description:
Defines the maximum amount of memory, in bytes, that can be allocated in a single chunk.
Max_String_Length
File: typedefs.pas
Type: longint constant (Pascal)
Description:
Defines the maximum length of strings, in bytes.
Min_Bytes
File: cvt.pas
Type: integer function
Parameters:
Name |
Type |
Description |
V |
String |
Value for which to return the number of bytes required. |
Base |
integer |
Base of the number in V. |
Description:
For the passed value, of the passed base, this function returns the minimum number of bytes required to represent that value. For instance, if V is "FF" and Base is 16, the result is 1. Note that the result will be random if the Base is out of the range 2 to 49, inclusive, or if V contains digits which are not valid for the passed base.
MessageBeep
File: smu.pas
Type: procedure (non-Windows only)
Parameters:
Name |
Type |
Description |
X |
Word |
Ignored. Pass 0. |
Description:
Calling this procedure beeps the PC speaker.
Min_Match
File: parse.pas
Type: boolean function
Parameters:
Parameter |
||
Type |
Description |
|
Full |
String |
Full string to match. |
Partial |
String |
Partial string to match. |
Len |
Integer |
Minimum number of characters which must match. |
Description:
Returns true if partial string matches full string, with a minimum of Len characters. The function sets the global Parse_Error value.
Mid
File: misc.pas, misc.c
Type: string function (Pascal), char* function (C)
Parameters:
Parameter |
||
Type |
Description |
|
C |
String |
Source string. |
Beginning |
Integer |
Starting position. |
Count |
Integer (int) |
Number of characters to return. If this is less than 1, a null string is returned. |
Description:
Returns the portion of the passed string from the Beginning position for the number of specified characters.
MKDir
File: files.pas
Type: longint function
Parameters:
Name |
Type |
Description |
Nam |
Const string |
Name and path of directory to create. |
Description:
Creates the specified directory. Returns 0 if success.
Model_*
File: smubios.pas
Type: constants
Description:
These constants define the hardware model being used by SMU.
Mnemonic |
Value |
Description |
|
0 |
Model is uninitialized. |
Model_Unknown |
1 |
Unknown hardware - use ANSI escape sequences. |
Model_Rainbow |
2 |
DEC Rainbow. |
Model_PC_Monochrome |
3 |
IBM PC, monochrome mode. |
Model_PC_Color_Text |
4 |
CGA/EGA/VGA/SVGA in text mode. |
Model_PC_Graphics |
5 |
CGA/EGA/VGA/SVGA in graphics mode. |
Model_Hercules |
6 |
Hercules video card.. |
Month_*
File: dates.pas
Type: constants
Description:
These constants provide mnemonics for months.
Mnemonic |
Value |
Meaning |
|
Month_January |
1 |
January |
|
Month_February |
2 |
February |
|
Month_March |
3 |
March |
|
Month_April |
4 |
April |
|
Month_May |
5 |
May |
|
Month_June |
6 |
June |
|
Month_July |
7 |
July |
|
Month_August |
8 |
August |
|
Month_September |
9 |
September |
|
Month_October |
10 |
October |
|
Month_November |
11 |
November |
|
Month_December |
12 |
December |
Move_To
File: smu.pas
Type: procedure
Parameters:
Parameter |
Type |
Description |
Window_P |
Pwindow |
Window to affect. |
Row |
integer |
Destination row. |
Column |
Integer |
Destination column. |
Description:
This procedure sets the cursor position to the specified location.
MP3_Genre
File: Media.pas
Type: array[ TMP3_Genre ] of string
Description:
This array contains string equivalents of the enumerations in TMP3_Genre.
MSDOS
File: compatib.pas
Type: procedure (Delphi)
Parameters:
Parameter |
Type |
Description |
Regs |
Var TRegisters |
Registers to pass to DOS. |
Description:
This procedure calls MSDOS.
MSDOS_Error
File: standard.pas, standard.c
Type: integer function (Pascal), int function (C)
Parameters: None
Description:
This function returns the extended DOS error code.
MW
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 149.
NAK
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 21 (Negative Acknowledge).
NBSP
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 160.
NEL
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 133.
New_Line
File: teu.c
Type: void function
Parameters: None
Description:
Inserts a new line break at the current position in the main TEU buffer, splitting the current line into two.
NTS_*
File: cvt.pas
Type: constants
Description:
These constants are used by the Numeric_To_String and String_To_Numeric functions.
Value |
Mnemonic |
Description |
0 |
NTS_Arabic |
Arabic values. For example "10". |
1 |
NTS_Roman |
Roman numerals. For example "IV". |
2 |
NTS_English |
English. For example "One hundred". |
3 |
NTS_Arabic_Ordinal |
Arabic ordinal. For example "3rd". |
4 |
NTS_English_Ordinal |
English ordinal. For example "third". |
5 |
NTS_Metric_Prefix |
Metric prefix. For example "Mega". |
6 |
NTS_Radix |
Radix. For example "octal". |
7 |
NTS_Alt_Radix |
Alternate radix. For example " Octinary". |
8 |
NTS_Group0 |
"Solo", "Duet", "Trio", etc. |
9 |
NTS_Group1 |
"Unity", "Duality", and "Trinity". |
10 |
NTS_Group2 |
"Monad", "Dyad", "Triad", etc. |
11 |
NTS_Group3 |
"Simplex", "Duplex", "Triplex", etc. |
12 |
NTS_Prefix |
"Hemi", "Uni", "Tri", etc. |
13 |
NTS_Alt_Prefix |
"Mono", "Di", "Tri", etc. |
14 |
NTS_Greek_Prefix |
"Hex", "Hepta", "Octa", etc. |
15 |
NTS_Multiplier |
"Quarter", "Half", "Triple", etc. |
16 |
NTS_Math |
"Niladic", "Monadic", "Dyadic", etc. |
17 |
NTS_Positional |
"Primary", "Secondary", "Tertiary", etc. |
18 |
NTS_2D |
2-dimensional shape. For example "Triangle". |
19 |
NTS_3D |
3-dimensional shape. For example "Octahedron". |
20 |
NTS_Government |
Form of government. For example "Pentarchy". |
21 |
NTS_Metric_Abbreviation |
Metric abbreviation. For example "M" (for Mega). |
NUL
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 0 (Null).
Num
File: nums.c
Type: char* function
Parameters:
Parameter |
Type |
Description |
X |
long |
Value to convert. |
Description:
This function returns the passed value as a string.
Num
File: num1s.pas
Type: string function
Parameters:
Parameter |
Type |
Description |
X |
Longint |
Value to convert. |
Description:
This function returns the passed value as a string.
Num1
File: nums.c
Type: char* function
Parameters:
Parameter |
Type |
Description |
X |
double |
Value to convert. |
Description:
This function returns the passed value as a string.
Num1
File: num1s.pas
Type: string function
Parameters:
Parameter |
Type |
Description |
X |
real |
Value to convert. |
Description:
This function returns the passed value as a string.
Num2
File: num1s.pas
Type: string function
Parameters:
Parameter |
Type |
Description |
X |
extended |
Value to convert. |
Description:
This function returns the passed value as a string.
Num2
File: nums.c
Type: string function
Parameters:
Parameter |
Type |
Description |
X |
long double |
Value to convert. |
Description:
This function returns the passed value as a string.
Numeric_To_String
File: cvt.pas
Type: string function
Parameters:
Parameter |
Type |
Description |
Numeric |
Double |
Value to convert. |
Typ |
Integer |
Type of conversion. This is one of the NTS_* mnuemonics. |
Description:
This function returns the passed value as a string, converted according to Typ.
ODigits
File: odigits.asm
Type: routine (8086 assembler)
Description:
Looks at the value in AX and returns, in CX, the number of octal digits necessary (1 to 6) to represent that value. No flags or registers (other than CX) are affected by this routine.
Open
File: files.pas
Type: Pfile function
Parameters:
Name |
Type |
Description |
Name |
Const string |
Name and path of file to open. |
Mode |
Integer |
Open mode (see FSOM_*). |
UEC |
Var TUEC |
Ignored on call. The result code on return. |
Description:
Opens a file, returning a pointer to a Tfile object for file I/O.
Open_File_System
File: files.pas
Type: Pfile_System function
Parameters:
Name |
Type |
Description |
Name |
Const string |
Name of file system to open. |
Flags |
Ineger |
Open flags. |
Res |
TUEC |
Ignored on call. The result code on return. |
Description:
Opens the specified file system and returns a pointer to it. Call Close_File_System when done with the object.
Operation_Handler
File: operatio.pas
Type: procedure type (Pascal)
Parameters:
Name |
Type |
Description |
ID |
Integer |
User-supplied ID for the operation. |
Data |
pointer |
User-supplied data for the operation. |
Description:
This is used for callbacks for the TOperation_Logger and ROperation record.
OS
File: O_S.pas
Type: Poperating_System function
Parameters: None
Description:
This function returns the Operating System interface object.
OS_ID
File: standard.pas, standard.c
Type: string function (Pascal), char* function (C)
Parameters: None
Description:
This function returns the current Operating System name and version number.
OSC
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 157.
OutBLen
File: io.asm
Type: DB
Description:
Length of data in OutBuff, in bytes.
OutBuff
File: io.asm
Type: DB 256 DUP (0)
Description:
Output buffer used for assembly I/O routines.
OutR
File: output.asm
Type: routine
Parameters:
Register |
Description |
DL |
Byte to ouput. |
Description:
This routine outputs a character to the screen. No data is returned. CCPOS is modified to reflect current output position on terminal.
Output
File: output.asm
Type: routine
Parameters:
Parameter |
Description |
CX |
Length of string, in bytes. |
DS:BX |
Location of first byte of string to output. |
Description:
This routine outputs a string to the screen. No data is returned. CCPOS is modified to reflect current output position on terminal.
Output_Text
File: smu.asm
Type: procedure
Parameters:
Parameter |
Type |
Description |
S |
String |
Text to write. |
Description:
This procedure writes the passed text to the current position of the current SMU window.
PackTime
File: compatib.pas
Type: procedure (Delphi)
Parameters:
Parameter |
Type |
Description |
DT |
Var DateTime |
The value to pack into Time |
Time |
Var longint |
Ignored when called, the packed value of DT on return. |
Description:
Pointer to tANSIString_Array.
Pallocator
File: heap.pas
Type: type (pointer)
Description
Pointer to Tallocator.
pANSIString_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to tANSIString_Array.
Parse_Command_Line
File: parse.pas
Type: string function
Parameters: None
Description:
Returns the command line used to invoke the program.
Parse_Error
File: parse.pas
Type: global integer
Description:
The code indicating the result of the last parse function call.
Parse_IO
File: parse.pas
Type: procedure
Parameters:
Parameter |
||
Type |
Description |
|
Command |
String |
String to parse. |
Input_Spec |
Var String |
Ignored on call, the input portion of the specification on return. |
Output_Spec |
Var String |
Ignored on call, the output portion of the specification on return. |
Description:
This procedure splits the passed command into two strings representing the input file specification and the output file specification. The procedure supports both of the formats:
input output
output = input
Parse_Parameter
File: parse.cpp
Type: char* function
Parameters:
Parameter |
||
Type |
Description |
|
X |
char* |
The string to be parsed on call. The remaining unparsed string on return. |
Description:
This function returns the next parameter in the passed string, delimited by a space or comma.
Parse_Parameter
File: parse.pas
Type: string function
Parameters:
Parameter |
||
Type |
Description |
|
Separator |
String |
The separator character to use in parsing the parameter. |
Command |
Var string |
The string to be parsed on call. The remaining unparsed string on return. |
Description:
This function returns the next parameter in the passed string, delimited by the passed separator.
Parse_Quote
File: parse.pas
Type: string function
Parameters:
Parameter |
||
Type |
Description |
|
S |
String |
The string to parse. |
Description:
This function takes a string and returns an unquoted version of it. Quoted portions of the string can be quoted with quote marks (") or apostrophes ('). Multiple quoted segments can be concatenated together. Some examples:
Passed |
|
Returned |
|
"Hello" |
Hello |
"I'm fine" |
I'm fine |
I "can't "say '"it"' |
I can't say "it" |
Parse_Sirius_Timestamp
File: dates.pas
Type: procedure
Parameters:
Name |
Type |
Description |
||
|
Int64 |
Time since midnight in 1/100 seconds. |
||
|
Var word |
Ignored when passed. The year on return. |
||
|
Var word |
Ignored when passed. The month on return. |
||
|
Var word |
Ignored when passed. The number of days on return. |
||
|
Var word |
Ignored when passed. The number of hours on return. |
||
|
Var word |
Ignored when passed. The number of minutes on return. |
||
|
Var word |
Ignored when passed. The number of seconds on return. |
||
|
Var longint |
Ignored when passed. The number of nanoseconds on return. |
Description:
Converts the passed Sirius timestamp into the individual date and time values.
Parse_Switch
File: parse.pas
Type: Integer function
Parameters:
Parameter |
||
Type |
Description |
|
Switch |
String |
Switch to remove from Command, without slashes. The switch may have a vertical bar to indicate the minimum abbreviation allowed (everything left of the bar is required for a match). A list of switches may be passed, using commas are delimiters. The function limits the switches to 16 characters (additional characters are ignored). Examples: 'OUT|PUT' |
Alternate |
String |
Alternate switch to remove from Command. Same format as Switch. This switch is usually the opposite of the switch passed in Switch. |
Command |
Var String |
String to parse. |
Parameter |
Var String |
Ignored on call; the switch parameter (if any) on return. Switch parameters are determined by a colon (:) or equal sign (=) following the switch. The data following the character is what is returned in this string. Note that if the parameter contains space characters or slashes, it must be quoted with single (') or double (") quotes. |
Description:
This function parses the specified switch from the passed command string, removes it from the command string, and returns any parameters associated with the switch. Multiple copies of the same switch and alternate switch are all removed. If more than one is found, the last one occuring in the string determines the result of the function (ie, all but the last are removed and ignored). Only switches beginning with slashes are recognized.
Function returns:
0 = No matching switches found
1 = Switch matching one in
Switch was found
2 = Switch matching one in Alternate was found
Parse_Time
File: dates.pas
Type: procedure
Parameters:
Name |
Type |
Description |
|
|
Longint |
Time since midnight in 1/100 seconds. |
|
|
Var Integer |
Ignored when passed. The number of days on return. |
|
|
Var Integer |
Ignored when passed. The number of hours on return. |
|
|
Var Integer |
Ignored when passed. The number of minutes on return. |
|
|
Var Integer |
Ignored when passed. The number of seconds on return. |
|
|
Var Integer |
Ignored when passed. The number of 1/100 seconds on return. |
Description:
Converts the passed time into the individual time values.
ParseErr_*
File: parse.pas
Type: constants
Description:
Constants defining errors returned by various parse routines.
Mnuemonic |
||
Value |
Description |
|
ParseErr_Success |
0 |
Successful parse. |
ParseErr_Ambiguous_Match |
-1 |
Indicates that Min_Match failed due to a switch which was less than the minimum match. |
ParserErr_*
File: parse.pas
Type: constants
Description:
Constants definining error conditions in Tparser.
Mnuemonic |
||
Value |
Description |
|
ParserErr_Success |
0 |
Last operation was successful. |
ParserErr_Unexpected_End_Of_File |
1 |
The end of the source was encountered. |
ParserErr_Unterminated_Literal |
2 |
A quoted literal was found, but no terminating quote was found on the line. |
ParserErr_No_Source |
3 |
No source has been specified and an operation was called to access the source. |
PBlock_Device
File: files.pas
Type: pointer
Description:
Pointer to Tblock_Device.
pBoolean
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to Boolean.
pBoolean_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to TBoolean_Array.
pByte
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to byte.
pByte_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to tByte_Array.
pByteArray
File: typedefs.pas
Type: type (Pascal)
Description:
Synonym to pByte_Array.
pByteBool
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to ByteBool.
pByteBool_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to TByteBool_Array.
PCache
File: cache.pas
Type: type (pointer)
Description:
Pointer to Tcache.
pCardinal
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to Cardinal.
pCardinal_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to tCardinal_Array.
PCommon_COM_Interface
File: COMInter.pas
Type: type (Delphi)
Description:
Equivalent to tCommon_COM_Interface.
pComp
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to Comp.
pComp_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to tComp_Array.
pCurrency_Array
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to tCurrency_Array .
Pdebug_Interface
File: debugint.h, debugint.pas
Type: type (pointer)
Description:
Pointer to a tDebug_Interface (Borland Pascal and C). Synonym for tDebug_Interface (Delphi).
Pi
File: maths.pas
Type: Extended function
Parameters: None
Description:
Returns the constant for Pi (3.14156...).
PSymbol_Deletion_Logger
File: symbols.pas
Type: type (pointer)
Description:
Pointer to TSymbol_Deletion_Logger.
pDouble
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to Double.
PSymbol_Table
File: symbols.pas
Type: type (pointer)
Description:
Pointer to Tsymbol_Table.
pDouble_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to TDouble_Array .
pEditor
File: ueditor.pas
Type: type (pointer)
Description:
Pointer to tEditor.
pError_Interface
File: uehdefs.pas
Type: type (pointer - Borland Pascal), class (Delphi)
Description:
Pointer to tError_Interface (Borland Pascal); synonym with tError_Interface (Delphi).
pExtended
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to Extended.
pExtended_Array
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to TExtended_Array.
pFile
File: typedefs.pas, files.pas
Type: type (pointer)
Description:
Pointer to File (typedefs); pointer to Tfile (files).
pFile_Array
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to tFile_Array.
Pfile_System
File: files.pas
Type: type (pointer)
Description:
Pointer to Tfile_System.
PFile_System_Server
File: files.pas
Type: type (pointer)
Description:
Pointer to Tfile_System_Server.
PFind_Record
File: files.pas
Type: type (pointer)
Description:
Pointer to Tfind_Record.
Pheap
File: heap.pas
Type: type (pointer)
Description:
Pointer to Theap.
PID
File: standard.pas
Type: longint function
Parameters: None
Description:
Returns the current process ID.
pInt64
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to Int64.
pInt64_Array
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to tInt64_Array.
pInteger
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to Integer.
pInteger_Array
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to tInteger_Array.
PLD
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 139.
PLine_Buffer
File: ueditor.pas
Type: type (pointer)
Description:
This is a pointer to tLine_Buffer.
pLogger
File: loggers.h, loggers.pas
Type: type (pointer - Borland Pascal), class (Delphi)
Description:
This is a pointer to tLogger (Borland Pascal). In Delphi, this is a synonym to tLogger.
pLongBool
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to LongBool.
pLongBool_Array
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to tLongBool_Array.
pLongint
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to Longint.
pLongint_Array
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to tLongint_Array.
pLongword
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to Longword.
pLongword_Array
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to tLongword_Array.
PLU
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 140.
PM
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 158.
Pmanaged_Store
Fle: Heap.pas
Type: pointer (type)
Description:
Pointer to Tmanaged_Store
PMemory_Store
File: memstore.pas
Type: type (pointer)
Description:
Pointer to Tmemory_Store.
Point_To_String
File: VCLDebug.pas
Type: string function
Parameters:
Name |
Type |
Description |
X |
TPoint |
Point for which to return a description. |
Description:
This function returns a description for the passed point.
Pointer_To_String
File: ustrings.pas
Type: string function
Parameters:
Name |
Type |
Description |
P |
pointer |
Pointer to convert to string. |
Description:
This function returns the passed string in a human-readable numeric form.
pOLEVariant_Array
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to tOLEVariant_Array.
Polygon
File: lines.pas
Type: procedure (Delphi)
Parameters:
Name |
Type |
Description |
C |
Tcanvas |
Canvas on which to draw. |
Points |
Array of TPoint |
Open array of points defining polygon. A line is drawn between each adjacent point. The first and last points are considered adjacent. |
Description:
Draws a polygon on the canvas, using black lines.
Poperation
File: operatio.pas
Type: type (pointer)
Description:
Pointer to ROperation.
Poperating_System
File: osint.pas
Type: type (pointer)
Description:
Pointer to Toperating_System.
POperation_Logger
File: operatio.pas
Type: type (pointer)
Description:
Pointer to TOperation_Logger.
POutline
File: outlines.pas
Type: type (pointer)
Description:
Pointer to Toutline.
Poutline_Node
File: outlines.pas
Type: type (pointer)
Description:
Pointer to Toutline_Node.
Power
File: maths.pas
Type: real function
Parameters:
Name |
Type |
Description |
X |
Real |
Value to take to a power. |
N |
Real |
Power to take X to. |
_Result |
integer |
Ignored on call. On return, this is the result of the operation: 0 = success. |
Description:
This function returns the result of one number to the power of another (X^N).
pPChar_Array
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to tPChar_Array.
pPointer
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to Pointer.
pPointer_Array
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to tPointer_Array.
pPSP
File: tsrs.pas
Type: type (pointer)
Description:
Pointer to tPSP.
pReal
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to Real.
pReal_Array
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to TReal_Array.
pReal48
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to Real48.
pReal48_Array
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to tReal48_Array.
Print_Edit
File: ustrings.pas
Type: string function
Parameters:
Name |
Type |
Description |
Value |
String |
String to format. |
Description:
Returns the passed string, with non-printable ASCII values converted to periods (.).
Proc
File: smu.pas
Type: type
Description:
Equivalent to a procedure.
Program_Name
File: globals.pas
Type: string (Pascal)
Description:
Holds the name of the program. This should always be set at program-startup if any logging will be done.
pShortInt
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to ShortInt.
pShortInt_Array
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to TShortInt_Array.
pSingle
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to Single.
pSingle_Array
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to TSingle_Array.
pSmall_String
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to Small_String.
pSmall_String_Array
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to tSmall_String_Array.
PSpell_Checker
File: spellchk.pas
Type: type (pointer)
Description:
Pointer to tSpell_Checker.
Pstore
File: files.pas
Type: type (pointer)
Description:
Pointer to Tstore.
Pstore_Heap
File: storheap.pas
Type: type (pointer)
Description:
Pointer to Pstore_Heap.
PStore_Server
File: files.pas
Type: type (pointer)
Description:
Pointer to Tstore_Server.
pString
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to string (Borland Pascal); anonymous to string (Delphi).
pString_Array
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to tString_Array.
PSymbol_Entry
File: symbols.pas
Type: type (pointer)
Description:
Pointer to tSymbol_Entry.
pText
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to Text.
pText_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to tText_Array.
Ptext_Debugger
File: debugint.c, debugint.pas
Type: pointer
Description:
This defines a pointer to a tText_Debugger (C++ and Borland Pascal). It is a synonym for tText_Debugger (Delphi).
PU1
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 145.
PU2
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 146.
pVariant_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to tVariant_Array.
pWideChar
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to WideChar .
pWideChar_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to tWideChar_Array.
pWideString_Array
File: typedefs.pas
Type: type (Delphi)
Description:
Pointer to tWideString_Array.
PWildcard
File: files.pas
Type: type (pointer)
Description:
Pointer to Twildcard.
pWindow
File: smu.pas
Type: type (pointer)
Description:
Pointer to Window.
pWord
File: typedefs.pas
Type: type (pointer)
Description:
Pointer to Word.
pWord_Array
File: typedefs.pas
Type: type
Description:
Pointer to tWord_Array .
pWordArray
File: typedefs.pas
Type: type (Pascal)
Description:
Synonymous with tWord_Array.
pWordBool
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to WordBool.
pWordBool_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Pointer to TWordBool_Array.
Rad
File: misc.pas, misc.c
Type: string function (Pascal), char* function (C)
Name |
Type |
Description |
Source |
Integer |
Value to convert. |
Description:
Converts the passed 16-bit integer value to a three-character string, decompressed via Radix-50 (used on PDP-11 computers). See Rad50.
Rad
Type: extended function
Parameters:
Name |
Type |
Description |
X |
extended |
Degree to convert. |
Description:
Converts passed value from Degree to Radian.
Rad50
File: misc.pas, misc.c
Type: integer function (Pascal), int function (C)
Parameters:
Name |
Type |
Description |
Source |
String |
String to convert. Only the first three characters are processed. |
Description:
Converts the passed string to a 16-bit integer value, compressed via Radix-50 (used on PDP-11 computers). See Rad.
RComparison
File: ustrings.pas
Type: record (Pascal)
Fields:
Name |
Type |
Description |
Weight |
array[ 0..255 ] of integer |
Weight to assign to each character. |
Bias |
array[ 0..255 ] of integer |
Bias to apply to each character. |
Compensation |
array[ 0..255 ] of integer |
Compensation for each character. |
Description:
Used in Compare_Strings to determine the rules for the comparison.
Real48
File: typedefs.pas
Type: type (Pascal)
Description:
Synonymous with Real.
Reallocate
File: compatib.pas
Type: procedure
Parameters:
Parameter |
Type |
Description |
P |
Var pointer |
Pointer to data to reallocate. |
Old_Size |
longint |
Old size of data. |
New_Size |
longint |
New size of data. |
Description:
Reallocates the data pointed to by the passed pointer to the new size, in bytes.
Rect_To_String
File: VCLDebug.pas
Type: string function
Parameters:
Name |
Type |
Description |
X |
Trec |
Rectangle for which to return a description. |
Description:
This function returns a description for the passed rectangle.
Redraw
File: teu.c
Type: void function
Parameters: None
Description:
Redraws the screen.
Refresh_Screen
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters: None
Description:
This function refreshes the screen from all mapped windows. This is used when something outside of SMU writes to the screen.
Refresh_Window
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Parameter |
Type |
Description |
Window_P |
Pwindow |
SMU window to refresh. |
Description:
This function refreshes the contents of a mapped window. This is used when something outside of SMU writes to the screen.
Register_Error_Interface
File: errmastr.pas
Type: longbool function
Parameters:
Parameter |
Type |
Description |
EI |
pError_Interface |
Error interface to register. |
Description:
This function registers the passed error interface which can then be used to translate UECs for the supported facility to text. The function returns true if success or false if EI is nil or an error interface for this facility was already registered and was not an older version.
Register_File_System_Server
File: files.pas
Type: procedure
Parameters:
Name |
Type |
Description |
FSS |
Pfile_System_Server |
File system server to register. |
Description:
Registers a Tfile_System_Server.
Register_Store_Server
File: files.pas
Type: procedure
Parameters:
Name |
Type |
Description |
SS |
PStore_Server |
Store server to register. |
Description:
Registers a TStore_Server.
Resize
File: smu.pas
Type: procedure
Parameters:
Name |
Type |
Description |
Window_P |
Var Pwindow |
Store server to register. |
New_Rows |
integer |
Number of rows to change window to. |
New_Columns |
Integer |
Number of columns to change window to. |
Description:
Resizes an SMU window to the new dimensions.
RGB_*
File: colors.pas
Type: TRGB and TWide_RGB constants
Description:
These constants are color names with associated RGB values. There are two versions of each color: one for TRGB and one for TWide_RGB. The versions for TWide_RGB have "_Wide" appended to the color name (for instance "RGB_Black" and "RGB_Black_Wide"). Th e alphas component of each color is set to the maximum. Note that some of the colors are different names for the same RGB values. The following is a list of the constant names.
RGB_Alice_Blue_Wide RGB_Alice_Blue RGB_Antique_White_Wide RGB_Antique_White RGB_Antique_White1_Wide RGB_Antique_White1 RGB_Antique_White2_Wide RGB_Antique_White2 RGB_Antique_White3_Wide RGB_Antique_White3 RGB_Antique_White4_Wide RGB_Antique_White4 RGB_Aquamarine_Wide RGB_Aquamarine RGB_Aquamarine1_Wide RGB_Aquamarine1 RGB_Aquamarine2_Wide RGB_Aquamarine2 RGB_Aquamarine3_Wide RGB_Aquamarine3 RGB_Aquamarine4_Wide RGB_Aquamarine4 RGB_Azure_Wide RGB_Azure RGB_Azure1_Wide RGB_Azure1 RGB_Azure2_Wide RGB_Azure2 RGB_Azure3_Wide RGB_Azure3 RGB_Azure4_Wide RGB_Azure4 RGB_Banana_Wide RGB_Banana RGB_Beige_Wide RGB_Beige RGB_Bisque_Wide RGB_Bisque RGB_Bisque1_Wide RGB_Bisque1 RGB_Bisque2_Wide RGB_Bisque2 RGB_Bisque3_Wide RGB_Bisque3 RGB_Bisque4_Wide RGB_Bisque4 RGB_Black_Wide RGB_Black RGB_Blanched_Almond_Wide RGB_Blanched_Almond RGB_Blue_Violet_Wide RGB_Blue_Violet RGB_Blue_Wide RGB_Blue RGB_Blue1_Wide RGB_Blue1 RGB_Blue2_Wide RGB_Blue2 RGB_Blue3_Wide RGB_Blue3 RGB_Blue4_Wide RGB_Blue4 RGB_Brick_Wide RGB_Brick RGB_Brown_Wide RGB_Brown RGB_Brown1_Wide RGB_Brown1 RGB_Brown2_Wide RGB_Brown2 RGB_Brown3_Wide RGB_Brown3 RGB_Brown4_Wide RGB_Brown4 RGB_Burlywood_Wide RGB_Burlywood RGB_Burlywood1_Wide RGB_Burlywood1 RGB_Burlywood2_Wide RGB_Burlywood2 RGB_Burlywood3_Wide RGB_Burlywood3 RGB_Burlywood4_Wide RGB_Burlywood4 RGB_Burnt_Sienna_Wide RGB_Burnt_Sienna RGB_Burnt_Umber_Wide RGB_Burnt_Umber RGB_Cadet_Blue_Wide RGB_Cadet_Blue RGB_Cadet_Blue1_Wide RGB_Cadet_Blue1 RGB_Cadet_Blue2_Wide RGB_Cadet_Blue2 RGB_Cadet_Blue3_Wide RGB_Cadet_Blue3 RGB_Cadet_Blue4_Wide RGB_Cadet_Blue4 RGB_Cadmium_Orange_Wide RGB_Cadmium_Orange RGB_Cadmium_Red_Wide RGB_Cadmium_Red RGB_Cadmium_Yellow_Wise RGB_Cadmium_Yellow RGB_Chartreuse_Wide RGB_Chartreuse RGB_Chartreuse1_Wide RGB_Chartreuse1 RGB_Chartreuse2_Wide RGB_Chartreuse2 RGB_Chartreuse3_Wide RGB_Chartreuse3 RGB_Chartreuse4_Wide RGB_Chartreuse4 RGB_Chocolate_Wide RGB_Chocolate RGB_Chocolate1_Wide RGB_Chocolate1 RGB_Chocolate2_Wide RGB_Chocolate2 RGB_Chocolate3_Wide RGB_Chocolate3 RGB_Chocolate4_Wide RGB_Chocolate4 RGB_Cobalt_Green_Wide RGB_Cobalt_Green RGB_Cobalt_Wide RGB_Cobalt RGB_Coral_Wide RGB_Coral RGB_Coral1_Wide RGB_Coral1 RGB_Coral2_Wide RGB_Coral2 RGB_Coral3_Wide RGB_Coral3 RGB_Coral4_Wide RGB_Coral4 RGB_Cornflower_Blue_Wide RGB_Cornflower_Blue RGB_Cornsilk_Wide RGB_Cornsilk RGB_Cornsilk1_Wide RGB_Cornsilk1 RGB_Cornsilk2_Wide RGB_Cornsilk2 RGB_Cornsilk3_Wide RGB_Cornsilk3 RGB_Cornsilk4_Wide RGB_Cornsilk4 RGB_Crimson_Wide RGB_Crimson RGB_Cyan_Wide RGB_Cyan RGB_Cyan1_Wide RGB_Cyan1 RGB_Cyan2_Wide RGB_Cyan2 RGB_Cyan3_Wide RGB_Cyan3 RGB_Cyan4_Wide RGB_Cyan4 RGB_Dark_Goldenrod_Wide RGB_Dark_Goldenrod RGB_Dark_Goldenrod1_Wide RGB_Dark_Goldenrod1 RGB_Dark_Goldenrod2_Wide RGB_Dark_Goldenrod2 RGB_Dark_Goldenrod3_Wide RGB_Dark_Goldenrod3 RGB_Dark_Goldenrod4_Wide RGB_Dark_Goldenrod4 RGB_Dark_Gray RGB_Dark_Green_Wide RGB_Dark_Green RGB_Dark_Khaki_Wide RGB_Dark_Khaki RGB_Dark_Olive_Green_Wide RGB_Dark_Olive_Green RGB_Dark_Olive_Green1_Wide RGB_Dark_Olive_Green1 RGB_Dark_Olive_Green2_Wide RGB_Dark_Olive_Green2 RGB_Dark_Olive_Green3_Wide RGB_Dark_Olive_Green3 RGB_Dark_Olive_Green4_Wide RGB_Dark_Olive_Green4 RGB_Dark_Orange_Wide RGB_Dark_Orange RGB_Dark_Orange1_Wide RGB_Dark_Orange1 RGB_Dark_Orange2_Wide RGB_Dark_Orange2 RGB_Dark_Orange3_Wide RGB_Dark_Orange3 RGB_Dark_Orange4_Wide RGB_Dark_Orange4 RGB_Dark_orchid_Wide RGB_Dark_Orchid RGB_Dark_Orchid1_Wide RGB_Dark_Orchid1 RGB_Dark_Orchid2_Wide RGB_Dark_Orchid2 RGB_Dark_Orchid3_Wide RGB_Dark_Orchid3 RGB_Dark_Orchid4_Wide RGB_Dark_Orchid4 RGB_Dark_Purple_Wide RGB_Dark_Purple RGB_Dark_Salmon_Wide RGB_Dark_Salmon RGB_Dark_Sea_Green_Wide RGB_Dark_Sea_Green RGB_Dark_Sea_Green1_Wide RGB_Dark_Sea_Green1 RGB_Dark_Sea_Green2_Wide RGB_Dark_Sea_Green2 RGB_Dark_Sea_Green3_Wide RGB_Dark_Sea_Green3 RGB_Dark_Sea_Green4_Wide RGB_Dark_Sea_Green4 RGB_Dark_Slate_Blue_Wide RGB_Dark_Slate_Blue RGB_Dark_Slate_Gray_Wide RGB_Dark_Slate_Gray RGB_Dark_Slate_Gray1_Wide RGB_Dark_Slate_Gray1 RGB_Dark_Slate_Gray2_Wide RGB_Dark_Slate_Gray2 RGB_Dark_Slate_Gray3_Wide RGB_Dark_Slate_Gray3 RGB_Dark_Slate_Gray4_Wide RGB_Dark_Slate_Gray4 RGB_Dark_Turquoise_Wide RGB_Dark_Turquoise RGB_Dark_Violet_Wide RGB_Dark_Violet RGB_Deep_Pink_Wide RGB_Deep_Pink RGB_Deep_Pink1_Wide RGB_Deep_Pink1 RGB_Deep_Pink2_Wide RGB_Deep_Pink2 RGB_Deep_Pink3_Wide RGB_Deep_Pink3 RGB_Deep_Pink4_Wide RGB_Deep_Pink4 RGB_Deep_Sky_Blue_Wide RGB_Deep_Sky_Blue RGB_Deep_Sky_Blue1_Wide RGB_Deep_Sky_Blue1 RGB_Deep_Sky_Blue2_Wide RGB_Deep_Sky_Blue2 RGB_Deep_Sky_Blue3_Wide RGB_Deep_Sky_Blue3 RGB_Deep_Sky_Blue4_Wide RGB_Deep_Sky_Blue4 RGB_Dim_Gray_Wide RGB_Dim_Gray RGB_Dodger_Blue_Wide RGB_Dodger_Blue RGB_Dodger_Blue1_Wide RGB_Dodger_Blue1 RGB_Dodger_Blue2_Wide RGB_Dodger_Blue2 RGB_Dodger_Blue3_Wide RGB_Dodger_Blue3 RGB_Dodger_Blue4_Wide RGB_Dodger_Blue4 RGB_Eggshell_Wide RGB_Eggshell RGB_Emerald_Green_Wide RGB_Emerald_Green RGB_Fire_Brick_Wide RGB_Fire_Brick RGB_Fire_Brick1_Wide RGB_Fire_Brick1 RGB_Fire_Brick2_Wide RGB_Fire_Brick2 RGB_Fire_Brick3_Wide RGB_Fire_Brick3 RGB_Fire_Brick4_Wide RGB_Fire_Brick4 RGB_Floral_White_Wide RGB_Floral_White RGB_Forest_Green_Wide RGB_Forest_Green RGB_Gainsboro_Wide RGB_Gainsboro RGB_Ghost_White_Wide RGB_Ghost_white RGB_Gold_Wide RGB_Gold RGB_Gold1_Wide RGB_Gold1 RGB_Gold2_Wide RGB_Gold2 RGB_Gold3_Wide RGB_Gold3 RGB_Gold4_Wide RGB_Gold4 RGB_Goldenrod_Wide RGB_Goldenrod RGB_Goldenrod1_Wide RGB_Goldenrod1 RGB_Goldenrod2_Wide RGB_Goldenrod2 RGB_Goldenrod3_Wide RGB_Goldenrod3 RGB_Goldenrod4_Wide RGB_Goldenrod4 RGB_Gray_Wide RGB_Gray RGB_Gray0_Wide RGB_Gray0 RGB_Gray1_Wide RGB_Gray1 RGB_Gray10_Wide RGB_Gray10 RGB_Gray100_Wide RGB_Gray100 RGB_Gray11_Wide RGB_Gray11 RGB_Gray12_Wide RGB_Gray12 RGB_Gray13_Wide RGB_Gray13 RGB_Gray14_Wide RGB_Gray14 RGB_Gray15_Wide RGB_Gray15 RGB_Gray16_Wide RGB_Gray16 RGB_Gray17_Wide RGB_Gray17 RGB_Gray18_Wide RGB_Gray18 RGB_Gray19_Wide RGB_Gray19 RGB_Gray2_Wide RGB_Gray2 RGB_Gray20_Wide RGB_Gray20 RGB_Gray21_Wide RGB_Gray21 RGB_Gray22_Wide RGB_Gray22 RGB_Gray23_Wide RGB_Gray23 RGB_Gray24_Wide RGB_Gray24 RGB_Gray25_Wide RGB_Gray25 RGB_Gray26_Wide RGB_Gray26 RGB_Gray27_Wide RGB_Gray27 RGB_Gray28_Wide RGB_Gray28 RGB_Gray29_Wide RGB_Gray29 RGB_Gray3_Wide RGB_Gray3 RGB_Gray30_Wide RGB_Gray30 RGB_Gray31_Wide RGB_Gray31 RGB_Gray32_Wide RGB_Gray32 RGB_Gray33_Wide RGB_Gray33 RGB_Gray34_Wide RGB_Gray34 RGB_Gray35_Wide RGB_Gray35 RGB_Gray36_Wide RGB_Gray36 RGB_Gray37_Wide RGB_Gray37 RGB_Gray38_Wide RGB_Gray38 RGB_Gray39_Wide RGB_Gray39 RGB_Gray4_Wide RGB_Gray4 RGB_Gray40_Wide RGB_Gray40 RGB_Gray41_Wide RGB_Gray41 RGB_Gray42_Wide RGB_Gray42 RGB_Gray43_Wide RGB_Gray43 RGB_Gray44_Wide RGB_Gray44 RGB_Gray45_Wide RGB_Gray45 RGB_Gray46_Wide RGB_Gray46 RGB_Gray47_Wide RGB_Gray47 RGB_Gray48_Wide RGB_Gray48 RGB_Gray49_Wide RGB_Gray49 RGB_Gray5_Wide RGB_Gray5 RGB_Gray50_Wide RGB_Gray50 RGB_Gray51_Wide RGB_Gray51 RGB_Gray52_Wide RGB_Gray52 RGB_Gray53_Wide RGB_Gray53 RGB_Gray54_Wide RGB_Gray54 RGB_Gray55_Wide RGB_Gray55 RGB_Gray56_Wide RGB_Gray56 RGB_Gray57_Wide RGB_Gray57 RGB_Gray58_Wide RGB_Gray58 RGB_Gray59_Wide RGB_Gray59 RGB_Gray6_Wide RGB_Gray6 RGB_Gray60_Wide RGB_Gray60 RGB_Gray61_Wide RGB_Gray61 RGB_Gray62_Wide RGB_Gray62 RGB_Gray63_Wide RGB_Gray63 RGB_Gray64_Wide RGB_Gray64 RGB_Gray65_Wide RGB_Gray65 RGB_Gray66_Wide RGB_Gray66 RGB_Gray67_Wide RGB_Gray67 RGB_Gray68_Wide RGB_Gray68 RGB_Gray69_Wide RGB_Gray69 RGB_Gray7_Wide RGB_Gray7 RGB_Gray70_Wide RGB_Gray70 RGB_Gray71_Wide RGB_Gray71 RGB_Gray72_Wide RGB_Gray72 RGB_Gray73_Wide RGB_Gray73 RGB_Gray74_Wide RGB_Gray74 RGB_Gray75_Wide RGB_Gray75 RGB_Gray76_Wide RGB_Gray76 RGB_Gray77_Wide RGB_Gray77 RGB_Gray78_Wide RGB_Gray78 RGB_Gray79_Wide RGB_Gray79 RGB_Gray8_Wide RGB_Gray8 RGB_Gray80_Wide RGB_Gray80 RGB_Gray81_Wide RGB_Gray81 RGB_Gray82_Wide RGB_Gray82 RGB_Gray83_Wide RGB_Gray83 RGB_Gray84_Wide RGB_Gray84 RGB_Gray85_Wide RGB_Gray85 RGB_Gray86_Wide RGB_Gray86 RGB_Gray87_Wide RGB_Gray87 RGB_Gray88_Wide RGB_Gray88 RGB_Gray89_Wide RGB_Gray89 RGB_Gray9_Wide RGB_Gray9 RGB_Gray90_Wide RGB_Gray90 RGB_Gray91_Wide RGB_Gray91 RGB_Gray92_Wide RGB_Gray92 RGB_Gray93_Wide RGB_Gray93 RGB_Gray94_Wide RGB_Gray94 RGB_Gray95_Wide RGB_Gray95 RGB_Gray96_Wide RGB_Gray96 RGB_Gray97_Wide RGB_Gray97 RGB_Gray98_Wide RGB_Gray98 RGB_Gray99_Wide RGB_Gray99 RGB_Green_Wide RGB_Green_Yellow_Wide RGB_Green_Yellow RGB_Green RGB_Green1_Wide RGB_Green1 RGB_Green2_Wide RGB_Green2 RGB_Green3_Wide RGB_Green3 RGB_Green4_Wide RGB_Green4 RGB_Honeydew_Wide RGB_Honeydew RGB_Honeydew1_Wide RGB_Honeydew1 RGB_Honeydew2_Wide RGB_Honeydew2 RGB_Honeydew3_Wide RGB_Honeydew3 RGB_Honeydew4_Wide RGB_Honeydew4 RGB_Hot_Pink_Wide RGB_Hot_pink RGB_Hot_Pink1_Wide RGB_Hot_Pink1 RGB_Hot_Pink2_Wide RGB_Hot_Pink2 RGB_Hot_Pink3_Wide RGB_Hot_Pink3 RGB_Hot_Pink4_Wide RGB_Hot_Pink4 RGB_Indian_Red_Wide RGB_Indian_Red RGB_Indian_Red1_Wide RGB_Indian_Red1 RGB_Indian_Red2_Wide RGB_Indian_Red2 RGB_Indian_Red3_Wide RGB_Indian_Red3 RGB_Indian_Red4_Wide RGB_Indian_Red4 RGB_Ivory_Black_Wide RGB_Ivory_Black RGB_Ivory_Wide RGB_Ivory RGB_Ivory1_Wide RGB_Ivory1 RGB_Ivory2_Wide RGB_Ivory2 RGB_Ivory3_Wide RGB_Ivory3 RGB_Ivory4_Wide RGB_Ivory4 RGB_Khaki_Wide RGB_Khaki RGB_Khaki1_Wide RGB_Khaki1 RGB_Khaki2_Wide RGB_Khaki2 RGB_Khaki3_Wide RGB_Khaki3 RGB_Khaki4_Wide RGB_Khaki4 RGB_Lavender_Blush_Wide RGB_Lavender_Blush RGB_Lavender_Blush1_Wide RGB_Lavender_Blush1 RGB_Lavender_Blush2_Wide RGB_Lavender_Blush2 RGB_Lavender_Blush3_Wide RGB_Lavender_Blush3 RGB_Lavender_Blush4_Wide RGB_Lavender_Blush4 RGB_Lavender_Wide RGB_Lavender RGB_Lawn_Green_Wide RGB_Lawn_Green RGB_Lemon_Chiffon_Wide RGB_Lemon_Chiffon RGB_Lemon_Chiffon1_Wide RGB_Lemon_Chiffon1 RGB_Lemon_Chiffon2_Wide RGB_Lemon_Chiffon2 RGB_Lemon_Chiffon3_Wide RGB_Lemon_Chiffon3 RGB_Lemon_Chiffon4_Wide RGB_Lemon_Chiffon4 RGB_Light_Blue_Wide RGB_Light_Blue RGB_Light_Blue1_Wide RGB_Light_Blue1 RGB_Light_Blue2_Wide RGB_Light_Blue2 RGB_Light_Blue3_Wide RGB_Light_Blue3 RGB_Light_Blue4_Wide RGB_Light_Blue4 RGB_Light_Coral_Wide RGB_Light_Coral RGB_Light_Cyan_Wide RGB_Light_Cyan RGB_Light_Cyan1_Wide RGB_Light_Cyan1 RGB_Light_Cyan2_Wide RGB_Light_Cyan2 RGB_Light_Cyan3_Wide RGB_Light_Cyan3 RGB_Light_Cyan4_Wide RGB_Light_Cyan4 RGB_Light_goldenrod_Wide RGB_Light_Goldenrod_yellow_Wide RGB_Light_Goldenrod_Yellow RGB_Light_Goldenrod RGB_Light_Goldenrod1_Wide RGB_Light_Goldenrod1 RGB_Light_Goldenrod2_Wide RGB_Light_Goldenrod2 RGB_Light_Goldenrod3_Wide RGB_Light_Goldenrod3 RGB_Light_Goldenrod4_Wide RGB_Light_Goldenrod4 RGB_Light_Gray_Wide RGB_Light_Gray RGB_Light_Pink_Wide RGB_Light_Pink RGB_Light_Pink1_Wide RGB_Light_Pink1 RGB_Light_Pink2_Wide RGB_Light_Pink2 RGB_Light_Pink3_Wide RGB_Light_Pink3 RGB_Light_Pink4_Wide RGB_Light_Pink4 RGB_Light_Salmon_Wide RGB_Light_Salmon RGB_Light_Salmon1_Wide RGB_Light_Salmon1 RGB_Light_Salmon2_Wide RGB_Light_Salmon2 RGB_Light_Salmon3_Wide RGB_Light_Salmon3 RGB_Light_Salmon4_Wide RGB_Light_Salmon4 RGB_Light_Sea_Green_Wide RGB_Light_Sea_Green RGB_Light_Sky_Blue_Wide RGB_Light_Sky_Blue RGB_Light_Sky_Blue1_Wide RGB_Light_Sky_Blue1 RGB_Light_Sky_Blue2_Wide RGB_Light_Sky_Blue2 RGB_Light_Sky_Blue3_Wide RGB_Light_Sky_Blue3 RGB_Light_Sky_Blue4_Wide RGB_Light_Sky_Blue4 RGB_Light_Slate_Blue_Wide RGB_Light_Slate_Blue RGB_Light_Slate_Gray_Wide RGB_Light_Slate_Gray RGB_Light_Steel_Blue_Wide RGB_Light_Steel_blue RGB_Light_Steel_Blue1_Wide RGB_Light_Steel_Blue1 RGB_Light_Steel_Blue2_Wide RGB_Light_Steel_Blue2 RGB_Light_Steel_Blue3_Wide RGB_Light_Steel_Blue3 RGB_Light_Steel_Blue4_Wide RGB_Light_Steel_Blue4 RGB_Light_Yellow_Wide RGB_Light_Yellow RGB_Light_Yellow1_Wide RGB_Light_Yellow1 RGB_Light_Yellow2_Wide RGB_Light_Yellow2 RGB_Light_Yellow3_Wide RGB_Light_Yellow3 RGB_Light_Yellow4_Wide RGB_Light_Yellow4 RGB_Lime_Green_Wide RGB_Lime_Green RGB_Linen_Wide RGB_Linen RGB_Magenta_Wide RGB_Magenta RGB_Magenta1_Wide RGB_Magenta1 RGB_Magenta2_Wide RGB_Magenta2 RGB_Magenta3_Wide RGB_Magenta3 RGB_Magenta4_Wide RGB_Magenta4 RGB_Manganese_Blue_Wide RGB_Manganese_Blue RGB_Maroon_Wide RGB_Maroon RGB_Maroon1_Wide RGB_Maroon1 RGB_Maroon2_Wide RGB_Maroon2 RGB_Maroon3_Wide RGB_Maroon3 RGB_Maroon4_Wide RGB_Maroon4 RGB_Medium_Aquamarine_Wide RGB_Medium_Aquamarine RGB_Medium_Blue_Wide RGB_Medium_Blue RGB_Medium_Forest_Green_Wide RGB_Medium_Forest_Green RGB_Medium_Goldenrod_Wide RGB_Medium_Goldenrod RGB_Medium_Orchid_Wide RGB_Medium_Orchid RGB_Medium_Orchid1_Wide RGB_Medium_Orchid1 RGB_Medium_Orchid2_Wide RGB_Medium_Orchid2 RGB_Medium_Orchid3_Wide RGB_Medium_Orchid3 RGB_Medium_Orchid4_Wide RGB_Medium_Orchid4 RGB_Medium_Purple_Wide RGB_Medium_Purple RGB_Medium_Purple1_Wide RGB_Medium_Purple1 RGB_Medium_Purple2_Wide RGB_Medium_Purple2 RGB_Medium_Purple3_Wide RGB_Medium_Purple3 RGB_Medium_Purple4_Wide RGB_Medium_Purple4 RGB_Medium_Sea_Green_Wide RGB_Medium_Sea_Green RGB_Medium_Slate_Blue_Wide RGB_Medium_Slate_Blue RGB_Medium_Spring_Green_Wide RGB_Medium_Spring_Green RGB_Medium_Turquoise_Wide RGB_Medium_Turquoise RGB_Medium_Violet_Red_Wide RGB_Medium_Violet_Red RGB_Melon_Wide RGB_Melon RGB_Midnight_Blue_Wide RGB_Midnight_Blue RGB_Mint_Cream_Wide RGB_Mint_Cream RGB_Misty_Rose_Wide RGB_Misty_Rose RGB_Misty_Rose1_Wide RGB_Misty_Rose1 RGB_Misty_Rose2_Wide RGB_Misty_Rose2 RGB_Misty_Rose3_Wide RGB_Misty_Rose3 RGB_Misty_Rose4_Wide RGB_Misty_Rose4 RGB_Moccasin_Wide RGB_Moccasin RGB_Navajo_White_Wide RGB_Navajo_White RGB_Navajo_White1_Wide RGB_Navajo_White1 RGB_Navajo_White2_Wide RGB_Navajo_White2 RGB_Navajo_White3_Wide RGB_Navajo_White3 RGB_Navajo_White4_Wide RGB_Navajo_White4 RGB_Navy_Blue_Wide RGB_Navy_Blue RGB_Navy_Wide RGB_Navy RGB_Old_Lace_Wide RGB_Old_Lace RGB_Olive_Drab_Wide RGB_Olive_Drab RGB_Olive_Drab1_Wide RGB_Olive_Drab1 RGB_Olive_Drab2_Wide RGB_Olive_Drab2 RGB_Olive_Drab3_Wide RGB_Olive_Drab3 RGB_Olive_Drab4_Wide RGB_Olive_Drab4 RGB_Orange_Red_Wide RGB_Orange_Red RGB_Orange_Red1_Wide RGB_Orange_Red1 RGB_Orange_Red2_Wide RGB_Orange_Red2 RGB_Orange_Red3_Wide RGB_Orange_Red3 RGB_Orange_Red4_Wide RGB_Orange_Red4 RGB_Orange_Wide RGB_Orange RGB_Orange1_Wide RGB_Orange1 RGB_Orange2_Wide RGB_Orange2 RGB_Orange3_Wide RGB_Orange3 RGB_Orange4_Wide RGB_Orange4 RGB_Orchid_Wide RGB_Orchid RGB_Orchid1_Wide RGB_Orchid1 RGB_Orchid2_Wide RGB_Orchid2 RGB_Orchid3_Wide RGB_Orchid3 RGB_Orchid4_Wide RGB_Orchid4 RGB_Pale_Goldenrod_Wide RGB_Pale_Goldenrod RGB_Pale_Green_Wide RGB_Pale_Green RGB_Pale_Green1_Wide RGB_Pale_Green1 RGB_Pale_Green2_Wide RGB_Pale_Green2 RGB_Pale_Green3_Wide RGB_Pale_Green3 RGB_Pale_Green4_Wide RGB_Pale_Green4 RGB_Pale_Turquoise_Wide RGB_Pale_Turquoise RGB_Pale_Turquoise1_Wide RGB_Pale_Turquoise1 RGB_Pale_Turquoise2_Wide RGB_Pale_Turquoise2 RGB_Pale_Turquoise3_Wide RGB_Pale_Turquoise3 RGB_Pale_Turquoise4_Wide RGB_Pale_Turquoise4 RGB_Pale_Violet_Red_Wide RGB_Pale_Violet_Red RGB_Pale_Violet_Red1_Wide RGB_Pale_Violet_Red1 RGB_Pale_Violet_Red2_Wide RGB_Pale_Violet_Red2 RGB_Pale_Violet_Red3_Wide RGB_Pale_Violet_Red3 RGB_Pale_Violet_Red4_Wide RGB_Pale_Violet_Red4 RGB_Papaya_Whip_Wide RGB_Papaya_Whip RGB_Peach_Puff_Wide RGB_Peach_Puff RGB_Peach_Puff1_Wide RGB_Peach_Puff1 RGB_Peach_Puff2_Wide RGB_Peach_Puff2 RGB_Peach_Puff3_Wide RGB_Peach_Puff3 RGB_Peach_Puff4_Wide RGB_Peach_Puff4 RGB_Peacock_Wide RGB_Peacock RGB_Peru_Wide RGB_Peru RGB_Pink_Wide RGB_Pink RGB_Pink1_Wide RGB_Pink1 RGB_Pink2_Wide RGB_Pink2 RGB_Pink3_Wide RGB_Pink3 RGB_Pink4_Wide RGB_Pink4 RGB_Plum_Wide RGB_Plum RGB_Plum1_Wide RGB_Plum1 RGB_Plum2_Wide RGB_Plum2 RGB_Plum3_Wide RGB_Plum3 RGB_Plum4_Wide RGB_Plum4 RGB_Powder_Blue_Wide RGB_Powder_Blue RGB_Puce_Wide RGB_Puce RGB_Purple_Wide RGB_Purple RGB_Purple1_Wide RGB_Purple1 RGB_Purple2_Wide RGB_Purple2 RGB_Purple3_Wide RGB_Purple3 RGB_Purple4_Wide RGB_Purple4 RGB_Raspberry_Wide RGB_Raspberry RGB_Raw_Sienna_Wide RGB_Raw_Sienna RGB_Raw_Umber_Wide RGB_Raw_Umber RGB_Red_Wide RGB_Red RGB_Red1_Wide RGB_Red1 RGB_Red2_Wide RGB_Red2 RGB_Red3_Wide RGB_Red3 RGB_Red4_Wide RGB_Red4 RGB_Rosy_Brown_Wide RGB_Rosy_Brown RGB_Rosy_Brown1_Wide RGB_Rosy_Brown1 RGB_Rosy_Brown2_Wide RGB_Rosy_Brown2 RGB_Rosy_Brown3_Wide RGB_Rosy_Brown3 RGB_Rosy_Brown4_Wide RGB_Rosy_Brown4 RGB_Royal_Blue_Wide RGB_Royal_Blue RGB_Royal_Blue1_Wide RGB_Royal_Blue1 RGB_Royal_Blue2_Wide RGB_Royal_Blue2 RGB_Royal_Blue3_Wide RGB_Royal_Blue3 RGB_Royal_Blue4_Wide RGB_Royal_Blue4 RGB_Saddle_Brown_Wide RGB_Saddle_Brown RGB_Salmon_Wide RGB_Salmon RGB_Salmon1_Wide RGB_Salmon1 RGB_Salmon2_Wide RGB_Salmon2 RGB_Salmon3_Wide RGB_Salmon3 RGB_Salmon4_Wide RGB_Salmon4 RGB_Sandy_Brown_Wide RGB_Sandy_Brown RGB_Sap_Green_Wide RGB_Sap_Green RGB_Sea_Green_Wide RGB_Sea_Green RGB_Sea_Green1_Wide RGB_Sea_Green1 RGB_Sea_Green2_Wide RGB_Sea_Green2 RGB_Sea_Green3_Wide RGB_Sea_Green3 RGB_Sea_Green4_Wide RGB_Sea_Green4 RGB_Seashell_Wide RGB_Seashell RGB_Seashell1_Wide RGB_Seashell1 RGB_Seashell2_Wide RGB_Seashell2 RGB_Seashell3_Wide RGB_Seashell3 RGB_Seashell4_Wide RGB_Seashell4 RGB_Sepia_Wide RGB_Sepia RGB_Sienna_Wide RGB_Sienna RGB_Sienna1_Wide RGB_Sienna1 RGB_Sienna2_Wide RGB_Sienna2 RGB_Sienna3_Wide RGB_Sienna3 RGB_Sienna4_Wide RGB_Sienna4 RGB_Sky_Blue_Wide RGB_Sky_Blue RGB_Sky_Blue1_Wide RGB_Sky_Blue1 RGB_Sky_Blue2_Wide RGB_Sky_Blue2 RGB_Sky_Blue3_Wide RGB_Sky_Blue3 RGB_Sky_Blue4_Wide RGB_Sky_Blue4 RGB_Slate_Blue_Wide RGB_Slate_Blue RGB_Slate_Blue1_Wide RGB_Slate_Blue1 RGB_Slate_Blue2_Wide RGB_Slate_Blue2 RGB_Slate_Blue3_Wide RGB_Slate_Blue3 RGB_Slate_Blue4_Wide RGB_Slate_Blue4 RGB_Slate_Gray_Wide RGB_Slate_Gray RGB_Slate_Gray1_Wide RGB_Slate_Gray1 RGB_Slate_Gray2_Wide RGB_Slate_Gray2 RGB_Slate_Gray3_Wide RGB_Slate_Gray3 RGB_Slate_Gray4_Wide RGB_Slate_Gray4 RGB_Snow_Wide RGB_Snow RGB_Snow1_Wide RGB_Snow1 RGB_Snow2_Wide RGB_Snow2 RGB_Snow3_Wide RGB_Snow3 RGB_Snow4_Wide RGB_Snow4 RGB_Spring_green_Wide RGB_Spring_Green RGB_Spring_Green1_Wide RGB_Spring_Green1 RGB_Spring_Green2_Wide RGB_Spring_Green2 RGB_Spring_Green3_Wide RGB_Spring_Green3 RGB_Spring_Green4_Wide RGB_Spring_Green4 RGB_Steel_Blue_Wide RGB_Steel_Blue RGB_Steel_Blue1_Wide RGB_Steel_Blue1 RGB_Steel_Blue2_Wide RGB_Steel_Blue2 RGB_Steel_Blue3_Wide RGB_Steel_Blue3 RGB_Steel_Blue4_Wide RGB_Steel_Blue4 RGB_Tan_Wide RGB_Tan RGB_Tan1_Wide RGB_Tan1 RGB_Tan2_Wide RGB_Tan2 RGB_Tan3_Wide RGB_Tan3 RGB_Tan4_Wide RGB_Tan4 RGB_Terre_Verte_Wide RGB_Terre_Verte RGB_Thistle_Wide RGB_Thistle RGB_Thistle1_Wide RGB_Thistle1 RGB_Thistle2_Wide RGB_Thistle2 RGB_Thistle3_Wide RGB_Thistle3 RGB_Thistle4_Wide RGB_Thistle4 RGB_Tomato_Wide RGB_Tomato RGB_Tomato1_Wide RGB_Tomato1 RGB_Tomato2_Wide RGB_Tomato2 RGB_Tomato3_Wide RGB_Tomato3 RGB_Tomato4_Wide RGB_Tomato4 RGB_Turquoise_Wide RGB_Turquoise RGB_Turquoise1_Wide RGB_Turquoise1 RGB_Turquoise2_Wide RGB_Turquoise2 RGB_Turquoise3_Wide RGB_Turquoise3 RGB_Turquoise4_Wide RGB_Turquoise4 RGB_Ultramarine_Wide RGB_Ultramarine RGB_Violet_Red_Wide RGB_Violet_Red RGB_Violet_Red1_Wide RGB_Violet_Red1 RGB_Violet_Red2_Wide RGB_Violet_Red2 RGB_Violet_Red3_Wide RGB_Violet_Red3 RGB_Violet_Red4_Wide RGB_Violet_Red4 RGB_Violet_Wide RGB_Violet RGB_Wheat_Wide RGB_Wheat RGB_Wheat1_Wide RGB_Wheat1 RGB_Wheat2_Wide RGB_Wheat2 RGB_Wheat3_Wide RGB_Wheat3 RGB_Wheat4_Wide RGB_Wheat4 RGB_white_Smoke_Wide RGB_White_Smoke RGB_White_Wide RGB_White RGB_Yellow_Green_Wide RGB_Yellow_Green RGB_Yellow_Wide RGB_Yellow RGB_Yellow1_Wide RGB_Yellow1 RGB_Yellow2_Wide RGB_Yellow2 RGB_Yellow3_Wide RGB_Yellow3 RGB_Yellow4_Wide RGB_Yellow4
RI
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 141.
Right
File: ustrings.pas, ustrings.c
Type: string function (Pascal), char* function (C)
Parameters:
Name |
Type |
Description |
C |
String |
String to copy. |
Position |
Integer |
Position to begin copy. |
Description:
This function returns the right portion of the passed string, starting at the specified position.
Roman_To_Arabic
File: cvt.c
Type: long function.
Parameters:
Name |
Type |
Description |
X |
char* |
Roman numeral to convert to integer. |
Description:
This function returns the integer value of the passed Roman numeral. For instance if "XI" is passed, 11 is returned.
Root
File: math.pas
Type: real function
Fields:
Name |
Type |
Description |
X |
real |
Value to return root of. |
R |
integer |
Root to return. |
Description:
This function returns the Rth root of X. For example, Root( 9, 3 ) returns 3.
ROperation
File: operatio.pas, operatio.h
Type: Record (Pascal), Struct (C++)
Fields:
Name |
Type |
Description |
Transaction |
Longint |
Transaction number. |
Typ |
Integer |
Transaction type. |
ID |
Operation_Handler Void(ID*)(int,void*) |
User-supplied operation handler routine. |
Data |
Pointer |
Data to pass to undo routine. |
Data_Size |
Integer |
Size of Data^ (in bytes). |
Next |
Poperation ROperation* |
Pointer to next operation in list. |
Description:
Defines an operation as used by the TOperation_Logger class.
RS
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 30 (Record Separator).
Scr
File: smu.pas
Type: Text
Description:
File to use to send output via SMU to the current window.
Scroll_Window
File: smu.pas
Type: procedure
Parameters:
Name |
Type |
Description |
Window_P |
Pwindow |
Window to scroll |
X |
Integer |
Number of rows to scroll. If positive, rows are scrolled up. If negative, rows are scrolled down. |
Y |
Integer |
Number of columns to scroll. If positive, columns are scrolled left. If negative, columns are scrolled right. |
Rect |
TRect |
Rectangle of window to scroll. |
Description:
Scrolls the specified window the specified amount.
SCUDT_*
File: scu.h, scuinc.pas
Type: constants (Delphi), defines (C++)
Description:
These constants define the data types used by SCU:
Constant |
Meaning |
SCUDT_Undefined |
Undefined type. |
SCUDT_Key |
Key. |
SCUDT_String |
Text. |
SCUDT_Integer |
4-bit, signed, 2's-complement integer. |
SCUDT_Boolean |
True/False. |
SCUDT_Float |
Double-precision floating-point. |
SCUDT_Binary |
Any data. |
SCUDT_All |
All types. |
SCUErr_*
File: scu.h, scuinc.pas
Type: constants (Delphi), defines (C++)
Description:
These constants define the error codes returned by SCU:
Constant |
Meaning |
SCUErr_Facility |
UEH facility code for SCU. |
SCUErr_Success |
Successful operation. |
SCUErr_Value_Not_Found |
Value was not found in SCU database. |
SCUErr_Invalid_Size |
A negative size was passed. |
SCUErr_Exists |
Key or value already exists on create operation. |
SCUErr_Alarm_Failure |
Operation caused an alarm which user used to abort operation. |
File: maths.pas
Type: extended function
Parameters:
Name |
Type |
Description |
X |
extended |
Value for which to return secant. |
Description:
Returns Secant of passed value.
Select_Window
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Name |
Type |
Description |
Window_P |
Pwindow |
SMU window. |
Description:
This function specifies which SMU window is to be the default window.
SERT
File: symbols.pas
Type: string function
Parameters:
Name |
Type |
Description |
X |
integer |
Error status code from a Tsymbol_Table operation. |
Description:
This function returns a string containing a text version of the passed symbol table error.
SetLength
File: standard.pas, compatib.pas
Type: procedure (Pascal)
Parameters:
Parameter |
Type |
Description |
X |
Pchar |
The string whose length to set. |
L |
Integer |
The length to which to set the string. |
Description:
This procedure sets the length of the passed string.
Set_Cursor
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Parameter |
Type |
Description |
Vr |
Integer |
Window row. |
Vc |
Integer |
Window column. |
Description:
This function sets the cursor position within the current SMU window.
_Set_Cursor
File: smubios.pas
Type: procedure
Parameters:
Parameter |
Type |
Description |
X |
Byte |
Window row. |
Y |
Byte |
Window column. |
Foreground |
Byte |
Foreground color for cursor. |
Background |
byte |
Background color for cursor. |
Description:
This function sets the cursor position within the current SMU window.
Set_Default_Window
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Parameter |
Type |
Description |
X |
Window_Record |
The SMU window to make the default. |
Description:
This procedure sets the default SMU window.
Set_Length
File: standard.pas
Type: procedure (Pascal)
Parameters:
Parameter |
Type |
Description |
X |
String or smallstring |
The string whose length to set. |
L |
Integer |
The length to which to set the string. |
Description:
This procedure sets the length of the passed string.
Set_Master_Error_Operation
File: errmastr.pas
Type: procedure
Parameters:
Parameter |
Type |
Description |
MEO |
Longint |
How Log_Error should handle errors: 0 = Silent (the default. This is the same as 1, but the error
codes are remembered and error text can be retrieved with
Last_Error.) |
Description:
This procedure sets the mode of operation for subsequent calls to the Log_Error function.
Set_Model
File: smubios.pas
Type: procedure
Parameters:
Parameter |
Type |
Description |
X |
integer |
PC hardware model. |
Description:
This sets up the screen environment. Normally this is only called from Init_Smu. See Model_*.
Set_Screen
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Parameter |
Type |
Description |
Model |
Integer |
PC hardware model. See Model_*. |
Printer_Model |
Integer |
Printer model. |
Input_Buffers |
Integer |
Number of input buffers. |
Mode |
Integer |
Screen mode. |
Description:
This sets up the screen environment. Normally this is only called from Init_Smu.
Set_Video_Mode
File: smubios.pas
Type: procedure
Parameters:
Parameter |
Type |
Description |
X |
Integer |
New video mode |
Description:
This changes the current video mode of the screen. See VM_*
Set_Viewport
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Parameter |
Type |
Description |
Row |
Byte (short int) |
Topmost window row. |
Column |
Byte |
Leftmost window column. |
Description:
This function adjusts the viewport of the default SMU window to have the specified upper-left corner.
Set_Window
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Parameter |
Type |
Description |
Window_P |
Pwindow |
SMU window to modify. |
Row |
Integer |
Window row position. Ignored if negative. |
Column |
Integer |
Column row position. Ignored if negative. |
Flag |
Integer |
Window flags. Ignored if 0 unless Row or Column is negative. |
Attributes |
Integer |
Display attributes: & 1 = Reverse-video |
Description:
This function sets the default display attributes, window flags, and/or the current cursor position for the specified SMU window.
Severity
File: errmastr.pas
Type: longint function
Parameters:
Parameter |
Type |
Description |
UEC |
TUEC |
UEC for which to return severity level. |
Description:
Returns the severity level of the passed UEC.
SF_*
File: express.pas
Type: constants
Description:
These constants are used in descendant classes of Texpression_Evaluator:
Name |
Value |
Meaning |
SF_Right_Unary_Operator |
1 |
This is an operator, operating on the value to the right of the operator. |
SF_Left_Unary_Operator |
2 |
This is an operator, operating on the value to the left of the operator. |
SF_Binary_Operator |
3 |
This is an operator, operating on values to the left and right. |
SF_Function |
4 |
This is a function, taking 0 or more parameters. |
ShortInt
File: typedefs.pas
Type: type
Description:
2-byte signed integer.
Show_Error
File: teu.c
Type: void function
Parameters:
Parameter |
Type |
Description |
X |
char* |
Error text to display. |
Description:
Displays the passed error text in the TEU error window.
Sgn
File: maths.pas, maths.c
Type: real function (Pascal), double function (C)
Parameters:
Parameter |
Type |
Description |
X |
Real (double) |
Value whose sign is to be returned. |
Description:
If X < 0, the function returns -1. If X > 0, the function returns 1. If X = 0, the function returns 0.
SHF_*
File: Storheap.pas
Type: constants
Description:
These constants are used as option flags for Tstore_Heap objects:
Mnuemonic |
Value |
Description |
SHF_NoExtend |
1 |
Don't extend store. |
SHF_NoClose |
2 |
Don't close store when done. |
SHF_Fast_Allocate |
4 |
Don't reallocate deallocated memory. |
SHF_Fast_Deallocate |
8 |
Don't deallocate memory. |
SHF_Read_Only |
16 |
Don't allow writes. |
SI
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 15 (Shift In).
Sirius_Timestamp
File: dates.pas
Type: int64 function
Parameters: None
Description:
The current system time as a Sirius timestamp.
Sleep
File: misc.pas
Type: procedure
Parameters:
Name |
Type |
Description |
X |
Integer |
Number of seconds to pause. |
Description:
This procedure causes the program to pause for the specified number of seconds. If X is negative, the absolute value is the number of seconds to pause, but the pause will end as soon as there is any keyboard input.
SmallInt
File: compatib.pas
Type: type (Borland Pascal)
Description:
Equivalent to Integer.
Small_String
File: typedefs.pas
Type: type (Pascal)
Description:
Synonymous to string (Borland Pascal) or string[255] (Delphi).
SO
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 14 (Shift Out).
SOH
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 1(Start of Heading).
Soundex
File: soundx.pas
Type: string function
Parameters:
Name |
Type |
Description |
X |
String |
Word to convert |
Description:
Converts a string into the corresponding soundex code.
SP
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 32 (Space).
SPA
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 150.
Space
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 32.
Space
File: misc.pas, misc.c
Type: string function (Pascal/Delphi), char* function (C)
Parameters:
Name |
Type |
Description |
X |
Byte (Borland Pascal) |
Number of spaces to return. |
Description:
Returns a string of spaces, with the specified length.
Split
File: wildcard.pas
Type: procedure
Parameters:
Name |
Type |
Description |
Path |
String |
Filename specification to parse. |
Dir |
Var string |
Ignored on call. The device and directory on return. |
Name |
Var string |
Ignored on call. The filename on return. |
Ext |
Var string |
Ignored on call. The file extension on return. |
Description:
This function takes a filename specification (with optional device and path) and returns the components of the specification.
SS2
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 142.
SS3
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 143.
SSA
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 134.
ST
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 156.
Strc
File: ustrings.c
Type: char* function
Parameters:
Name |
Type |
Description |
X |
char* |
Pointer to Pascal-style string to copy. |
Description:
This function returns a standard C string (null-terminated) from a Pascal string (1 byte length + data).
String
File: output.asm
Type: routine
Parameters:
Register |
Description |
CX |
Count of characters to output. |
AL |
Character to output. |
Description:
ASCII code 147.
String_To_Boolean
File: ustrings.pas
Type: boolean function
Parameters:
Name |
Type |
Description |
S |
string |
String to convert. |
Description:
This function converts the passed string to a boolean value.
String_To_Numeric
File: cvt.asm
Type: boolean function
Parameters:
Name |
Type |
Description |
S |
String |
String to convert. |
Numeric |
Var double |
Ignored on call. On return, this is the converted value. |
Typ |
Var integer |
Ignored on call. On return, this is the determined type of S. This is one of the NTS_* values. |
Description:
Converts the passed numeric string to a number and returns the type of the value. The return is True if the passed numeric string is recognized or false otherwise.
strpas
File: ustrings.c
Type: void
Parameters:
Name |
Type |
Description |
S |
String |
String to convert. |
Numeric |
Var double |
Ignored on call. On return, this is the converted value. |
Typ |
Var integer |
Ignored on call. On return, this is the determined type of S. This is one of the NTS_* values. |
Description:
Converts the passed numeric string to a number and returns the type of the value. The return is True if the passed numeric string is recognized or false otherwise.
STS
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 147.
STX
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 2 (Start Text).
SUB
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 26 (Substitute).
Substitute
File: ustrings.pas
Type: string function
Parameters:
Name |
Type |
Description |
A |
String |
String to translate. |
B |
String |
Conversion rules. |
Description:
Translate A based on B. Returns a string which is A, but with each character converted to characters in B based on ASCII values. For example, if A[ 1 ] is "A", then A[ 1 ] is set to B[ 65 ].
Switch_Present
File: parse.pas
Type: boolean function
Parameters:
Parameter |
||
Type |
Description |
|
Command |
String |
String to check. |
Description:
This function returns true if the passed string contains any switches. It properly handles quotes so that literal text cannot cause a true result.
SwapVectors
File: compatib.pas
Type: procedure (Delphi, Borland Pascal - Windows)
Description:
This procedure does nothing. It is provided for compatibility with Borland Pascal.
SYN
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 22 (Synchronous idle).
Tab
File: output.asm
Type: routine
Parameters:
Register |
Description |
CL |
Position to tab to. |
Description:
Positions output to specified column. CCPOS is maintained in IO.asm.
Tab2Space
File: format.pas
Type: string function (Pascal)
Parameters:
Parameter |
Type |
Description |
Count |
Integer |
Number of spaces in each tab field. A value of 8, for instance, would indicate that there are tabs every 8 columns (columns 9, 17, 25, etc). |
X |
Const String |
The string to convert. |
Description:
Convert string with tabs to string with appropriate spaces. The result of this function call is a string where each tab (ASCII 9) character has been replaced with spaces such that the text is aligned at tab columns. Count is the number of columns in each tab stop.
TAllocator
File: heap.h
Type: pure-virtual class
Description:
This class is the base class for various allocators, such as TMemory.
Tallocator
File: Allocatr.pas
Type: class
Methods:
Method |
Type |
Description |
Allow_Cache |
Boolean |
If true, part (or all) of the allocation table will be cached in memory. |
|
|
|
Get_Offset |
TStore_Address |
Offset of allocation information on store. |
Get_Resolution |
Integer |
Minimum allocation unit, in bytes. |
Get_Size |
Longint |
Physical size of persisted allocation information, in bytes. |
Get_Store |
Pstore |
The store to which the allocation information is persisted. |
Set_Offset( Value : TStore_Address ) |
n/a |
Sets the starting address of the store where the allocation information is to be persisted. |
Set_Resolution( Value : integer ) |
n/a |
Sets minimum allocation size, in bytes. |
Set_Size( Value : longint ) |
n/a |
Sets size of persisted allocation information, in bytes. |
Set_Store( Value : PStore ) |
n/a |
Sets the store to which the allocation information will be persisted. |
Flush |
N/a |
Writes any changed allocation information to the store. |
Allocate( Size : TStore_Address ) |
Tstore_Address |
Allocates room for Size bytes and returns the store offset. If no room can be found, the function returns 0. |
Allocate_At( Pos, Size : TStore_Address ) |
Boolean |
Allocates Size bytes at position Pos on what is being managed. If there isn’t room, False is returned, otherwise the appopriate room is allocated and the function returns True. |
Deallocate( PTR : TStore_Address ; Size : TStore_Address ) |
N/a |
Deallocates Size bytes starting at position PTR for what is being managed. |
Load |
n/a |
Loads the allocation information from the store. |
MaxSpace |
Longint |
Returns the total amount of unused space, in bytes, in the largest contiguous unallocated area. |
SpaceAvail |
Longint |
Returns the total amount of unused space, in bytes. |
Description:
TAllocator is the base class of all allocation objects. It provides a means of managing some range of a resource. For instance, it can be used to manage the space in a file (allocations and deallocations, reuse of deallocated storage, etc). The allocation information can be persisted to a TStore. The data for the allocation table must be contiguous on the store, but the size and starting offset can be set and changed as desired.
TAllocator_Statistics
File: heap.pas
Type: record
Members:
Name |
Type |
Description |
Bytes_Allocated |
Longint |
Sum total size of all allocations, in bytes. |
Bytes_Deallocated |
Longint |
Sum total size of all deallocations, in bytes. |
Allocations |
Longint |
Count of allocations. |
Deallocations |
Longint |
Count of deallocations. |
Reallocations |
Longint |
Count of physical reallocations. |
Reallocations_In_Place |
Longint |
Count of reallocations not requiring physical reallocation. |
Root_Writes |
Longint |
Count of writes to root. |
Root_Reads |
Longint |
Count of reads from root. |
Copies |
Longint |
Count of copy operations. |
Bytes_Copied |
Longint |
Bytes copied via Copy method. |
Fills |
Longint |
Count of fill operations. |
Bytes_Filled |
Longint |
Sum total number of bytes filled. |
Extensions |
Longint |
Number of extension operations. Note: Allocations - Extensions = allocations not requiring file extensions (reallocations). |
Description:
This record is used to track Tmanaged_Store usage statistics.
tANSIString_Array
File: typedefs.pas
Type: type (Delphi)
Description:
Defines an array of ANSIStrings from 0 up to the maximum elements allowed within Max_Memory.
Tan
File: maths.pas
Type: function
Parameters:
Name |
Type |
Description |
X |
Extended |
Value for which to return the tangent. |
Description:
Return tangent of a value.
TArray_Display
File: arraydis.pas
Type: class (Delphi)
Methods:
Method |
Type |
Description |
||
Create ( C : TwinControl ; AI : TArray_Interface ; Font : integer ; Background, Foreground : Tcolor ) |
constructor |
Constructs an instance of the class. |
||
Property Number_Size |
Longint |
The current number size, in bytes (1, 2, or 4). |
||
property _Array |
TArray_Interface |
The array interface instance being displayed. |
||
Property Ascii_Ebcdic |
Integer |
0 if ASCII text is shown, 1 if EBCDIC is shown. |
||
Property Base |
Integer |
Base for numeric display (2 through 50). Base 50 is radix-50. |
||
Display |
N/a |
Paints the display on the TwinControl passed to the constructor. |
||
Property Home_Index |
Int64 |
Indicates the index of the array shown at the top left of the display. |
||
LPP |
integer |
Number of lines shown on display. |
||
Property Max_Data |
integer |
Number of bytes shown per line on display. |
||
Property Unsigned |
Boolean |
True if numeric values to be shown as unsigned. False to show numeric values as signed. |
Description:
This class is used to display data from a Tarray_Interface instance in a GUI window (passed to constructor).
TArray_Display_Form
File: arrayint.h, arrayint.pas
Type: class (Delphi form)
Methods:
Method |
Description |
Serial_Number : longint |
Serial number of the object. |
|
|
property _Array : TArray_Interface |
Access to the array interface object from which data is obtained. |
property Display : TArray_Display |
Read-only. The display object used to paint the data. |
procedure Set_Caption( Value : string ) ; |
Sets the form caption to the passed value. |
Description:
This form is used to display array data.
TArray_Interface
File: arrayint.h, arrayint.pas
Type: class (C++ and Delphi)
Methods:
Method |
Description |
function Get_Byte( Index : int64 ) : byte ; unsigned char Get_Byte( int64 Index ); |
Return a byte from the given index. |
procedure Set_Byte( Index : int64 ; Value : byte ) ; void Set_Byte( int64 Index, unsigned char Value ); |
Set a byte at the specified index. |
function Read_Only : boolean ; bool Read_Only(); |
Returns true if the data is read-only. |
function Low_Bound( Subscript : integer ) : int64 ; int64 Low_Bound( int Subscript ); |
Returns low bound of specified subscript. |
function High_Bound( Subscript : integer ) : int64 ; int64 High_Bound( int Subscript ); |
Returns high bound of specified subscript. |
function Subscripts : integer ; int Subscripts(); |
Returns number of subscripts. |
property Bytes[ Index : int64 ] : byte |
(Delphi Only). Index-style access to Get_Byte and Set_Byte. |
Description:
This class is used to pass arrays (real or virtual). It is a descendant of TCommon_COM_Object.
TArrayOfInteger
File: typedefs.pas
Type: type (Pascal)
Description:
Equivalent to Tinteger_Array.
TAT
File: Allocatr.pas
Type: object
Methods:
Method |
Type |
Description |
Get_Modified |
Boolean |
Returns True if the allocation table has been modified since the last load or flush. |
Set_Modified( Value : boolean ) |
N/a |
Sets the state of the modified flag. |
Description:
This descendant of TAllocator implements an allocation table.
Tblock_Device
File: files.pas
Type: class
Description:
Tblock_Device is a descedant of Tfile, used to access block-oriented devices, such as disk drives. It operates as Tfile, except that text-mode operations are not allowed, and the record size is a fixed size corresponding to the device blocking factor.
tBoolean_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of Boolean from 0 up to the maximum elements allowed within Max_Memory..
TBPB
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Bytes_Per_Sector |
Word |
|
Sectors_Per_Cluster |
Byte |
|
Reserved_Sectors |
Word |
|
FAT_Count |
Byte |
|
Root_Directory_Entries |
Word |
|
Total_Sectors |
Word |
|
Media_ID |
Byte |
|
FAT_Sectors |
Word |
|
Sectors_Per_Track |
Word |
|
Heads |
Word |
|
Hidden_Sectors |
Word |
|
Description:
BPB (BIOS Parameter Block), Special - for DDT entries.
TBPBv2
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
|||
Jump |
array[ 0..2 ] of Byte |
Jump instruction |
|||
System_ID |
array[ 0..7 ] of Char |
Manufacturer name/version |
|||
Bytes_Per_Sector |
Word |
|
|||
Sectors_Per_Cluster |
Byte |
|
|||
Reserved_Sectors |
Word |
|
|||
FAT_Count |
Byte |
|
|||
Root_Directory_Entries |
Word |
|
|||
Total_Sectors |
Word |
|
|||
Media_ID |
Byte |
Media descriptor: F0 = 3.5" FDD, 2 sides, 80 tracks, 18 sectors/track F8 = HDD F9 = 5.25" FDD, 2 sides, 80 tracks, 15 sectors/track 3.5" FDD, 2 sides, 80 tracks, 9 sectors/track FA = FDD, 1 side, 80 tracks, 8 sectors/track FB = FDD, 2 sides, 80 tracks, 8 sectors/track FC = FDD, 1 side, 40 tracks, 9 sectors/track FD = FDD, 2 sides, 40 tracks, 9 sectors/track FE = FDD, 1 side, 40 tracks, 8 sectors/track FF = FDD, 2 sides, 40 tracks, 8 sectors/track |
|||
FAT_Sectors |
Word |
|
|||
Sectors_Per_Track |
Word |
|
|||
Heads |
Word |
|
|||
Hidden_Sectors |
Longint |
|
|||
( Data after this is bootstrap code in FAT12/FAT16 ) |
|
|
|||
FAT32 fields: |
|
|
|||
Total_Sectors_High |
Longint |
|
|||
FAT_Sectors_High |
Longint |
|
|||
Flags |
Word |
|
|||
Version |
Word |
|
|||
Root_Start_Cluster |
Longint |
|
|||
FS_Info_Sec |
Word |
|
|||
Backup_Boot_Sec |
Word |
|
|||
Reserved |
Word |
|
Description:
BPB (BIOS Parameter Block), DOS V2.n and V3.n. As it appears on disks without 8
sectors/track, in sector 0.
TBPBv4
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Jump |
array[ 0..2 ] of Byte |
|
System_ID |
array[ 0..7 ] of Char |
|
Bytes_Per_Sector |
Word |
|
Sectors_Per_Cluster |
Byte |
|
Reserved_Sectors |
Word |
|
FAT_Count |
Byte |
|
Root_Directory_Entries |
Word |
|
Total_Sectors |
Word |
|
Media_ID |
Byte |
|
FAT_Sectors |
Word |
|
Extended_Total_Sectors |
Longint |
|
Filler |
array[ 0..5 ] of Byte |
|
Cylinders |
Word |
|
Device_Type |
Byte |
|
Attributes |
Word |
|
Description:
BPB (BIOS Parameter Block), DOS V4.n.
tByte_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of Bytes from 0 up to the maximum elements allowed within Max_Memory..
tByteBool_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of ByteBools from 0 up to the maximum elements allowed within Max_Memory.
Tcache
File: cache.pas
Type: object
Methods:
Method |
Type |
Description |
Statistics |
TCache_Statistics |
Access statistics for this object. |
|
|
|
Clear |
n/a |
Clears cache contents. |
Get_Max_Size |
Longint |
Returns the current maximum cache size, in bytes. |
Get_Size |
longint |
Returns amount of currently cached data, in bytes. |
Initialize |
n/a |
Initializes the object. |
Lock( Address : longint ) |
Boolean |
Locks the data, starting at the specified address, into memory so that it is not thrown away. Returns false if the specified data is not in the cache. |
Read_Cache( var Data ; Address, Size : longint ) |
longint |
Reads up to Size bytes from the cache for the specified address. Returns the number of bytes actually read (if 0 then the data was not cached). Cached data is copied to Data |
Set_Max_Size( Size : longint ) |
n/a |
Sets maximum cache size, in bytes. If this is more than is currently cached, some cache is thrown away. |
Terminate |
n/a |
Terminates the object. |
Unlock( Address : longint ) |
boolean |
Unlocks the data starting at the specified address in memory. Returns false if the specified data is not in the cache, or if it is not locked. |
Write_Cache( var Data ; Address, Size : longint ) |
n/a |
Writes to cache up to Size bytes from Data. |
Description:
Tcache is used to cache data. It can be set to a maximum size so that the total cache doesn't exceed some preset amount.
TCache_Handler
File: cache.pas
Type: type - function( Siz, Code : longint ) : longint ;
Description:
This is the type used by the cache handling system (Add_Handler, Delete_Handler, and Free_Cache). Parameters of this type are used to access a cache handler. Cache handlers are passed a size (Siz) to free. If size is zero (0) then Code indicates a special operation to perform. For now, the only defined code is 0, which indicates that the function should return the amount of memory currently allocated in its cache. If Size is not zero, Code is ignored. If size is negative, then the cache should be completly zeroed.
TCache_Record
File: cache.h
Type: struct
Members:
Name |
Type |
Description |
Routine |
void (*Routine)(int, int) |
Cache handler pointer. |
Priority |
long int |
Priority of this cache. |
Next |
TCache_Record* |
Pointer to next record in list. |
Description:
This structure is used by the cache handler routines in cache.c.
TCache_Statistics
File: cache.pas
Type: record
Members:
Name |
Type |
Description |
Hits |
Longint |
Total read hits. |
Misses |
Longint |
Total read misses. |
Writes |
Longint |
Total write operations. |
Turns |
Longint |
Number of times blocks were thrown away to make room for more. |
Replacements |
Longint |
Number of write hits. |
Description:
This record holds cache access statistics. Note: Hits + Misses = total reads.
tCardinal_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of Cardinals from 0 up to the maximum elements allowed within Max_Memory..
TClick_Notify_Event
File: typedefs.pas
Type: procedure of object (Delphi)
Parameters:
Name |
Type |
Description |
Sender |
Tobject |
Object who sent the notification. |
Point |
TSmallPoint |
The location of the mouse click. |
Description:
Indicates a mouse click event at the specified location.
TCollection
File: collect.pas
Type: class (Delphi)
Methods:
Method |
Description |
constructor Init( ALimit, ADelta : integer ) ; |
Constructs the object. The collection is pre-allocated for ALimit items. The collection grows in increments of ADelta. Typical values are 0 for Alimit and 4 for ADelta. |
destructor Done ; |
Destructs the object. |
function At( Index : integer ) : pointer ; |
Returns the pointer at the specified index. If the Index is less than 0 or greater than the maximum current index, nil is returned. |
function Count : integer ; |
Returns the number of items in the collection. |
function IndexOf( Item : Pointer ) : integer ; |
Returns the index of the first pointer matching Item. If no match is found, the function returns -1. |
function Limit : integer ; |
Returns current limit of collection. |
procedure AtDelete( Index : integer ) ; |
Deletes the item at the specified index. All following items are moved down by one index and the count is reduced by 1. |
procedure AtInsert( Index : integer ; Item : string ) ; |
Inserts Item at the specified index. |
procedure AtPut( Index : integer ; Value : pointer ) ; |
Sets the specified index to the specified value. |
procedure Delete( Item : Pointer ) ; |
Deletes the specified item. Equivalent to AtDelete( IndexOf( Item ) ) . |
procedure DeleteAll ; |
Deletes all items in the collection. |
procedure Insert( Item : Pointer ) ; |
Inserts the specified item at the end of the collection. |
procedure SetLimit( ALimit : integer ) ; |
Sets the limit to the specified value. If ALimit is less than Count, the last items in the collection are deleted. |
Description:
This class provides an equivalent to the Borland Pascal TCollection class for Delphi. However, not all methods of the original Tollection are supported. TCollection stores a collection of pointers, accessed via an index (first index is 0).
TCommand_Event = procedure( Sender : TObject ; Command : integer ) of object ;
File: typedefs.pas
Type: procedure of object (Delphi)
Parameters:
Name |
Type |
Description |
Sender |
Tobject |
Object who sent the notification. |
Command |
integer |
The command being executed. |
Description:
Indicates a generic command is being executed.
TCommon_COM_Interface
File: cominter.h, cominter.pas
Type: class (Delphi and C++)
Methods:
Method |
Description |
Function Initialize : TUEC ; TUEC Initialize(); |
Initialize the object. Returns result of initialization attempt. |
function Terminate : TUEC ; TUEC Terminate(); |
Terminate the use of the object. Returns result of termination. This generally should not be used - instead, use the Detach method. |
procedure Attach ; void Attach(); |
Increments the reference count for the object. |
procedure Detach ; void Detach(); |
Decrements the reference count for the object. When count reaches 0, the object is destroyed. |
function Interface_Version : longint ; int Interface_Version(); |
Version of the COM interface for this object. |
function Facility_ID : longint ; int Facility_ID(); |
Facility ID for the facility represented by this object. Returns -1 if no facility assigned. |
function Facility_Version : longint ; int Facility_Version(); |
Facility version. Result only has meaning if Facility_ID doesn't return -1. |
function Debugger : PDebug_Interface ; TDebug_Interface* Debugger(); |
Returns a debugging interface for the object. Returns nil if not supported. |
function Extension : pointer ; void* Extension(); |
Returns a pointer to an object with extended common COM methods for object. Always returns nil for now. |
Description:
This class is used for COM components developed for the Application Foundation. All methods use stdcall calling convention.
tComp_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of Comps from 0 up to the maximum elements allowed within Max_Memory.
TComparison
File: typedefs.pas
Type: enumeration (Pascal)
Description:
Indicates the results of a magnitude comparison. The values are:
LessThan
EqualTo
GreaterThan
Tcomponent_Debug_Iterator
File: VCLDebug.pas
Type: class
Data members:
Name |
Type |
Description |
||
Component |
Tcomponent |
Component for which to provide debug interface |
Description:
This descendant of a TInherited_Debug_Iterator provides a debug interface for a Tcomponent.
Tcomponent_List_Debug_Iterator
File: VCLDebug.pas
Type: class
Data members:
Name |
Type |
Description |
||
Component |
Tcomponent |
Component whose component list is used to provide debug interface |
Description:
This descendant of a TInherited_Debug_Iterator provides a debug interface for a component list of a Tcomponent.
Tcontrol_Debug_Iterator
File: VCLDebug.pas
Type: class
Data members:
Name |
Type |
Description |
||
Control |
TControl |
Control for which to provide a debug interface |
Description:
This descendant of a TInherited_Debug_Iterator provides a debug interface for a Tcontrol.
tCurrency_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of Currencys from 0 up to the maximum elements allowed within Max_Memory.
TDDBv2
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Next |
Pointer |
|
Drive |
Byte |
|
Filler |
array[ 0..2 ] of Byte |
|
Sector |
Word |
|
Copies |
Byte |
|
Offset |
Byte |
|
Dpb |
Pointer |
|
Start |
Byte |
|
Description:
DDB (DOS Disk Buffer), DOS V2.n.
TDDBv3
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Next |
Pointer |
|
Drive |
Byte |
|
Flags |
Byte |
|
Sector |
Word |
|
Copies |
Byte |
|
Offset |
Byte |
|
Dpb |
Pointer |
|
Filler |
Word |
|
Start |
Byte |
|
Description:
DDB (DOS Disk Buffer), DOS V3.n.
TDDBv4
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Next |
Word |
|
Previous |
Word |
|
Drive |
Byte |
|
Flags |
Byte |
|
Sector |
Longint |
|
Copies |
Byte |
|
Offset |
Word |
|
Dpb |
Pointer |
|
Count |
Word |
|
Filler |
Byte |
|
Start |
Byte |
|
Description:
DDB (DOS Disk Buffer), DOS V4.n.
tDebug_Interface
File: debugint.c, debugint.pas
Type: class
Methods:
Name |
Parameters |
Result |
Description |
Count |
int (longi Type nt) |
n/a |
Returns the number of child components under this level. If this is a terminal (leaf) node, the method returns 0. |
Get_Title |
Char* (Pchar) |
n/a |
Returns text representing this level (such as "Cached data"). |
Set_Title |
Void |
char* (Pchar) |
Sets text representing this level. |
Activate |
Void |
n/a |
Indicates that the user wished to activate this level. The behavior is undefined and up to the implementor. Typically, this does nothing unless this level is a terminal representing some complex data which is not viewable in a hierarchical form. |
Can_Change |
bool (boolean) |
n/a |
Returns True if this item can be modified. |
Child |
tDebug_Interface* (pDebug_Interface) |
Index : int (longint) |
Returns a debug interface for the specified child level (first child level is 0). |
Kill |
void |
n/a |
Tells object to destroy itself. |
Modify |
char* (Pchar) |
Data : char* (Pchar), Size : int (integer) |
Modifies data. If Size is -1, Data is assumed to be null-terminated and its length is automatically determined. The result will be NULL (nil) or a pointer to a null string to indicate success and error text otherwise. |
Title |
char* (Pchar) |
Property (Delphi only) |
Interface to Get_Title and Set_Title. |
Description:
TDebug_Interface is used when debugging code by providing a way of examining the internals of the software component at run-time (for production versions of software, this is often not supported). The interface assumes a hierarchical form with the root of a component returning children representing internal objects. Each of those objects may have children, and so forth.
TDefault_Input
File: getchars.pas
Type: object (Pascal)
Methods:
Description:
This is a descendant of the Tinput_Source class which takes input from the computer's keyboard. The main differences from TInput_Source is that the source is the computer keyboard and InKey's cooked characters are strings which indicate the special key, or key-combination, that the user pressed. For normal keys, this is simply the key value (a single character such as "A", "?", or "+"). The following table lists the special keys/combinations returned by the method. Note that what keys are actually returned by a key press are dependant upon the keyboard itself, the current status of the NUM LOCK and CAPS LOCK, keyboard modes, and/or the keyboard driver. You should experiment to determine which special keys are actually returned on given hardware.
Value Return |
Key(s) Pressed |
"A" followed by any single character |
ALT, and the second character indicates the other key pressed. For instance, "AH" indicates ALT and the "H" key. |
ALTBACK |
ALT and BACKSPACE. |
ALTHOME |
ALT and HOME. |
ALTUP |
ALT and up-arrow. |
ALTDOWN |
ALT and down-arrow. |
ALTLEFT |
ALT and left-arrow. |
ALTRIGHT |
ALT and right-arrow. |
ALTEND |
ALT and END. |
ALTPAGEUP |
ALT and page-up. |
ALTPAGEDOWN |
ALT and page-down. |
ALTINSERT |
ALT and INSERT. |
ALTDELETE |
ALT and DELETE. |
AKP+ |
ALT and gray + |
AKP- |
ALT and gray - |
AKP/ |
ALT and gray / |
AF1 |
ALT and F1 |
AF2 |
ALT and F2 |
AF3 |
ALT and F3 |
AF4 |
ALT and F4 |
AF5 |
ALT and F5 |
AF6 |
ALT and F6 |
AF7 |
ALT and F7 |
AF8 |
ALT and F8 |
AF9 |
ALT and F9 |
AF10 |
ALT and F10 |
AF11 |
ALT and F11 |
AF12 |
ALT and F12 |
CKP- |
CTRL and gray - |
CKP+ |
CTRL and gray + |
CKP1 |
CTRL and keypad 1 |
CKP2 |
CTRL and keypad 2 |
CKP3 |
CTRL and keypad 3 |
CKP4 |
CTRL and keypad 4 |
CKP6 |
CTRL and keypad 6 |
CKP7 |
CTRL and keypad 7 |
CKP8 |
CTRL and keypad 8 |
CKP9 |
CTRL and keypad 9 |
CF1 |
CTRL and F1 |
CF2 |
CTRL and F2 |
CF3 |
CTRL and F3 |
CF4 |
CTRL and F4 |
CF5 |
CTRL and F5 |
CF6 |
CTRL and F6 |
CF7 |
CTRL and F7 |
CF8 |
CTRL and F8 |
CF9 |
CTRL and F9 |
CF10 |
CTRL and F10 |
CF11 |
CTRL and F11 |
CF12 |
CTRL and F12 |
UP |
Up-arrow |
DOWN |
Down-arrow |
RIGHT |
Right-arrow |
LEFT |
Left-arrow |
DELETE |
DELETE |
BACK |
BACKSPACE |
INSERT |
INSERT |
HOME |
HOME |
END |
END |
KP0 |
Keypad 0 (DEC keyboard only) |
KP1 |
Keypad 1 (DEC keyboard only) |
KP2 |
Keypad 2 (DEC keyboard only) |
KP3 |
Keypad 3 |
KP4 |
Keypad 4 (DEC keyboard only) |
KP5 |
Keypad 5 (DEC keyboard only) |
KP6 |
Keypad 6 (DEC keyboard only) |
KP7 |
Keypad 7 (DEC keyboard only) |
KP8 |
Keypad 8 (DEC keyboard only) |
KP9 |
Keypad 9 |
KP, |
Keypad , (DEC keyboard) |
KP. |
Keypad . (DEC keyboard only) |
PF1 |
PF1 (DEC keyboards) |
PF2 |
PF2 (DEC keyboards) |
PF3 |
PF3 (DEC keyboards) |
PF4 |
PF4 (DEC keyboards) |
ENTER |
Gray ENTER (DEC keyboard only) |
COMPOSE |
COMPOSE (DEC keyboard only) |
F1 |
F1 |
F2 |
F2 |
F3 |
F3 |
F4 |
F4 |
F5 |
F5 |
F6 |
F6 |
F7 |
F7 |
F8 |
F8 |
F9 |
F9 |
F10 |
F10 |
F11 |
F11 |
F12 |
F12 |
F14 |
F14 (DEC keyboard only) |
F15 |
F15 (DEC keyboard only) |
F16 |
F16 (DEC keyboard only) |
F17 |
F17 (DEC keyboard only) |
F18 |
F18 (DEC keyboard only) |
F19 |
F19 (DEC keyboard only) |
F20 |
F20 (DEC keyboard only) |
E1 |
SHIFT F1 |
E2 |
SHIFT F2 |
E3 |
SHIFT F3 |
E4 |
SHIFT F4 |
E5 |
SHIFT F5 |
E6 |
SHIFT F6 |
E7 |
SHIFT F7 |
E8 |
SHIFT F8 |
E9 |
SHIFT F9 |
E10 |
SHIFT F10 |
E11 |
SHIFT F11 |
E12 |
SHIFT F12 |
tDelphi_Object
File: common.pas
Type: type (Delphi)
Methods:
Method |
Description |
constructor Create ; |
Creates an instance of the object. |
destructor Destroy ; |
Destroys the object. |
procedure Attach ; |
Increments the reference counter by 1. |
procedure Detach ; |
Decrements the reference counter by 1. If the reference count falls below 1, the object is automatically freed. |
Description:
Defines the base object from which most Delphi-specific classes descend in the subroutine library. The main purpose is to implement reference counting so that many other objects can have pointers to a tDelphi_Object without being worried about who & ;ldquo;owns” the reference work. Instead, each object with a pointer to a tDelphi_Object simply attaches to the object when it gets the pointer, and detaches when it is done referencing the object. Once all attachments to the tDelphi_Object are released, it is automatically freed.
TDOS_CDSv3
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Curr_Path |
array[ 0..66 ] of Char |
|
Flags |
Word |
|
Dpb |
Pointer |
|
Redirifs |
Pointer |
|
Parameter |
Word |
|
Root_OFS |
Word |
|
Filler |
array[ 0..72 ] of Byte |
|
Start |
Word |
|
Filler0 |
Word |
|
Description:
CDS (Current Directory Structure), DOS 3.n.
TDOS_CDSv4
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Curr_Path |
array[ 0..66 ] of Char |
|
Flags |
Word |
|
Dpb |
Pointer |
|
Rediris |
Pointer |
|
Parameter |
Word |
|
Root_OFS |
Word |
|
Filler1 |
Byte |
|
IFS_Driver |
Pointer |
|
Filler2 |
Word |
|
Filler |
array[ 0..72 ] of Byte |
|
Start |
Word |
|
Filler0 |
Word |
|
Description:
CDS (Current Directory Structure), DOS 4.n.
TDOS_CTR
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Dd_1980 |
Word |
|
Minutes |
Byte |
|
Hours |
Byte |
|
Hundreths |
Byte |
|
Seconds |
Byte |
|
Description:
CTR (Clock Transfer Record).
TDOS_DBHCH
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Page |
Word |
|
Least_Used |
Pointer |
|
Dirty_Buffers |
Byte |
|
Filler |
Byte |
|
Description:
DBHCH (Disk Buffer Hash Chain Head), DOS V4.n.
TDOS_DBIv40
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Dbhch |
Pointer |
|
Chain_Count |
Word |
|
Lookahead |
Pointer |
|
Flag |
Byte |
|
Handle |
Word |
|
Page |
Word |
|
Filler |
Word |
|
Segment |
Word |
|
Filler1 |
Word |
|
Mapping |
array[ 0..3 ] of Word |
|
Description:
DBI (Disk Buffer Info), DOS V4.0.
TDOS_DBIv41
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Dbhch |
Pointer |
|
Chain_Count |
Word |
|
Lookahead |
Pointer |
|
Lookahead_Count |
Word |
|
Flag |
Byte |
|
Segment |
Word |
|
Page |
Word |
|
Segment1 |
Word |
|
Page1 |
Word |
|
Frames |
Byte |
|
Workspace |
Word |
|
Handle |
Word |
|
Page2 |
Word |
|
Filler |
Word |
|
Frame |
Word |
|
Filler1 |
Word |
|
Flag1 |
Byte |
|
Description:
DBI (Disk Buffer Info), DOS V4.01.
TDOS_DDH
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Next |
Pointer |
|
Attributes |
Word |
|
Exit_Point |
Word |
|
Entry_Point |
Word |
|
Sub_Units |
Byte |
|
Filler |
Array[ 0..6 ] of Byte |
|
Reserved |
Word |
|
Drive |
Char |
|
Units |
Byte |
|
Signature |
Array[ 0..5 ] of Byte |
|
Filler1 |
Array[ 0..9 ] of Byte |
|
Name |
Array[ 0..7 ] of Char |
|
Description:
DDH (Device Driver Header).
TDOS_DDTv3
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Next |
Pointer |
|
Unit_Number |
Byte |
|
Drive_Number |
Byte |
|
Bios_Pb |
BPB |
|
Filler |
Byte |
|
Open |
Word |
|
Volume_Label |
array[ 0..10 ] of Char |
|
Null |
Byte |
|
Device_Type |
Byte |
|
Flags |
Word |
|
Cylinders |
Word |
|
Max_Capacity |
BPB |
|
Filler1 |
array[ 0..2 ] of Byte |
|
File_System |
array[ 0..8 ] of Char |
|
Null1 |
Byte |
|
Last_Access |
Longint |
|
Description:
DDT (Drive Data Table), DOS V3.3.
TDOS_DDTv4
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Next |
Pointer |
|
Unit_Number |
Byte |
|
Drive_Number |
Byte |
|
Bios_Pb |
BPB |
|
Filler |
array[ 0..8 ] of Byte |
|
Device_Type |
Byte |
|
Flags |
Word |
|
Cylinders |
Word |
|
Max_Capacity |
BPB |
|
Filler1 |
array[ 0..12 ] of Byte |
|
Last_Access |
Longint |
|
Volume_Label |
array[ 0..10 ] of Char |
|
Null |
Byte |
|
Serial_Number |
Longint |
|
File_System |
array[ 0..7 ] of Char |
|
Null1 |
Byte |
|
Description:
DDT (Drive Data Table), DOS V4.n.
TDOS_Dir_Rec
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Name |
array[ 0..10 ] of char |
Special codes: first byte 0 = Last directory entry 5 = First character of filename is $E5 2E = File applies to current dir E5 = Deleted |
Attributes |
Byte |
And 1 = read-only And 2 = Hidden And 4 = System And 8 = Volume name/label And 16 = directory And 32 = Archive And 64 = reserved |
Reserved |
array[ 0..9 ] of Byte |
|
Update_Time |
Word |
0:4 = seconds in 2-second increments 5: 10 = Minute 11: 15 = Hour |
Update_Date |
Word |
0:4 = Day 5: 8 = Month 9 15 = Year - 1980 |
Start_Cluster |
Word |
|
Size |
Longint |
|
Description:
DOS Directory entry.
TDOS_DPBv1
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Drive |
Byte |
|
Unit_Number |
Byte |
|
Bytes_Per_Sector |
Word |
|
Largest_Sector |
Byte |
|
Shift_Count |
Byte |
|
Reserved_Sectors |
Word |
|
FAT_Copies |
Byte |
|
Root_Directory_Entries |
Word |
|
First_Data_Sector |
Word |
|
Max_Cluster |
Word |
|
Description:
DPB (Drive Parameter Block) For DOS V1.n.
TDOS_DPBv2
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Drive |
Byte |
|
Unit_Number |
Byte |
|
Bytes_Per_Sector |
Word |
|
Largest_Sector |
Byte |
|
Shift_Count |
Byte |
|
Reserved_Sectors |
Word |
|
FAT_Copies |
Byte |
|
Root_Directory_Entries |
Word |
|
First_Data_Sector |
Word |
|
Max_Cluster |
Word |
|
FAT_Sectors |
Byte |
|
Root_Sector |
Word |
|
Driver |
Pointer |
|
Media_ID |
Byte |
|
Rebuild |
Byte |
|
Next_Driver |
Pointer |
|
Current_Directory_Cluster |
Word |
|
Current_Path |
array[ 0..63 ] of Char |
|
Description:
DPB (Drive Parameter Block) For DOS V2.n.
TDOS_DPBv3
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Drive |
Byte |
|
Unit_Number |
Byte |
|
Bytes_Per_Sector |
Word |
|
Largest_Sector |
Byte |
|
Shift_Count |
Byte |
|
Reserved_Sectors |
Word |
|
FAT_Copies |
Byte |
|
Root_Directory_Entries |
Word |
|
First_Data_Sector |
Word |
|
Max_Cluster |
Word |
|
FAT_Sectors |
Byte |
|
Root_Sector |
Word |
|
Driver |
Pointer |
|
Media_ID |
Byte |
|
Rebuild |
Byte |
|
Next_Driver |
Pointer |
|
Search_Start |
Word |
|
Free_Clusters |
Word |
|
Description:
DPB (Drive Parameter Block) For DOS V3.n.
TDOS_DPBv4
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Drive |
Byte |
|
Unit_Number |
Byte |
|
Bytes_Per_Sector |
Word |
|
Largest_Sector |
Byte |
|
Shift_Count |
Byte |
|
Reserved_Sectors |
Word |
|
FAT_Copies |
Byte |
|
Root_Directory_Entries |
Word |
|
First_Data_Sector |
Word |
|
Max_Cluster |
Word |
|
FAT_Sectors |
Word |
|
Root_Sector |
Word |
|
Driver |
Pointer |
|
Media_ID |
Byte |
|
Rebuild |
Byte |
|
Next_Driver |
Pointer |
|
Search_Start |
Word |
|
Free_Clusters |
Word |
|
Description:
DPB (Drive Parameter Block) For DOS V4.n.
TDOS_FCB_Local
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Extended |
Byte |
FFH if extended, offset -7 |
Filler |
array[ 0..4 ] of Byte |
|
Extended_Attribute |
Byte |
Offset -1 |
Drive_Number |
Byte |
Offset 0 |
File_Name |
array[ 0..10 ] of Char |
|
Current_Block |
Word |
|
Record_Size |
Word |
|
File_Size |
Longint |
|
Date |
Word |
|
Time |
Word |
|
SFT_Number |
Byte |
|
Flags |
Byte |
|
Starting_Cluster |
Word |
|
SHARE_Offset |
Word |
|
Attributes |
Byte |
|
Filler1 |
Byte |
|
Current_Record |
Byte |
|
Record_Number |
Longint |
|
Description:
FCB (File Control Block) for V3.n, SHARE loaded, local file.
TDOS_FCB_Remote
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Extended |
Byte |
FFH if extended, offset -7 |
Filler |
array[ 0..4 ] of Byte |
|
Extended_Attribute |
Byte |
Offset -1 |
Drive_Number |
Byte |
Offset 0 |
File_Name |
array[ 0..10 ] of Char |
|
Current_Block |
Word |
|
Record_Size |
Word |
|
File_Size |
Longint |
|
Date |
Word |
|
Time |
Word |
|
Directory_Sector |
Word |
|
Relative_Cluster |
Word |
|
Absolute_Cluster |
Word |
|
Current_Record |
Byte |
|
Record_Number |
Longint |
|
Description:
FCB (File Control Block) for V3.n, SHARE loaded, remote file.
TDOS_FCBv1
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Extended |
Byte |
FFH if extended, offset -7 |
Filler |
array[ 0..4 ] of Byte |
|
Extended_Attribute |
Byte |
Offset -1 |
Drive_Number |
Byte |
Offset 0 |
File_Name |
array[ 0..10 ] of Char |
|
Current_Block |
Word |
|
Record_Size |
Word |
|
File_Size |
Longint |
|
Date |
Word |
|
Time |
Word |
|
Flags |
Byte |
|
Absolute_Cluster |
Word |
|
Starting_Cluster |
Word |
|
Relative_Cluster |
Word |
|
Filler1 |
Byte |
|
Current_Record |
Byte |
|
Record_Number |
Longint |
|
Description:
FCB (File Control Block) for V1.n.
TDOS_FCBv2
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Extended |
Byte |
FFH if extended, offset -7 |
Filler |
array[ 0..4 ] of Byte |
|
Extended_Attribute |
Byte |
Offset -1 |
Drive_Number |
Byte |
Offset 0 |
File_Name |
array[ 0..10 ] of Char |
|
Current_Block |
Word |
|
Record_Size |
Word |
|
File_Size |
Longint |
|
Date |
Word |
|
Time |
Word |
|
Flags |
Byte |
|
Starting_Cluster |
Word |
|
Filler1 |
array[ 0..4 ] of Byte |
|
Current_Record |
Byte |
|
Record_Number |
Longint |
|
Description:
FCB (File Control Block) for V2.n.
TDOS_FCBv3
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Extended |
Byte |
FFH if extended, offset -7 |
Filler |
array[ 0..4 ] of Byte |
|
Extended_Attribute |
Byte |
Offset -1 |
Drive_Number |
Byte |
Offset 0 |
File_Name |
array[ 0..10 ] of Char |
|
Current_Block |
Word |
|
Record_Size |
Word |
|
File_Size |
Longint |
|
Date |
Word |
|
Time |
Word |
|
Flags |
Byte |
|
Starting_Cluster |
Word |
|
Directory_Sector |
Word |
|
Directory_Entry |
Byte |
|
Current_Record |
Byte |
|
Record_Number |
Longint |
|
Description:
FCB (File Control Block) for V3.n, SHARE not loaded.
TDOS_Find_Record
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Reserved |
array[ 0..20 ] of byte |
|
Attributes |
byte |
|
Time |
word |
|
Date |
word |
|
Size |
longint |
|
Name |
array[ 0..12 ] of char |
|
Description:
Find record.
TDOS_Keybv3
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Int_09 |
Pointer |
|
Int_2F |
Pointer |
|
Filler |
array[ 0..5 ] of Byte |
|
Flags |
Word |
|
Filler1 |
array[ 0..5 ] of Byte |
|
Country_ID |
array[ 0..1 ] of Char |
|
Current_Code_Page |
Word |
|
First |
Word |
|
Ptr |
Word |
|
Filler2 |
array[ 0..1 ] of Byte |
|
Xlate |
Word |
|
Last |
Word |
|
Filler3 |
array[ 0..8 ] of Byte |
|
Description:
KEYB internal data, DOS V3.3.
TDOS_Keybv4
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Int_09 |
Pointer |
|
Int_2F |
Pointer |
|
Filler |
array[ 0..5 ] of Byte |
|
Flags |
Word |
|
Filler1 |
array[ 0..5 ] of Byte |
|
Country_ID |
array[ 0..1 ] of Char |
|
Current_Code_Page |
Word |
|
Filler2 |
array[ 0..1 ] of Byte |
|
First |
Word |
|
Ptr |
Word |
|
Filler3 |
array[ 0..1 ] of Byte |
|
Xlate |
Word |
|
Last |
Wor |
|
Filler4 |
array[ 0..8 ] of Byte |
|
Description:
KEYB internal data, DOS V4.n.
TDOS_Lock_Record
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Next |
Word |
|
Start |
Longint |
|
Ending |
Longint |
|
Sft |
Pointer |
|
Owner |
Word |
|
Description:
Lock record.
TDOS_LOLv2
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Filler |
array[ 0..13 ] of Byte |
Offset -16 |
MCB |
Word |
Offset -2 |
DPB |
Pointer |
Offset 0 |
SFT |
Pointer |
|
CLOCK_Driver |
Pointer |
|
CON_Driver |
Pointer |
|
Last_Drive |
Byte |
Offset $10 |
Max_Bytes_Per_Block |
Word |
|
First_Disk_Buffer |
Pointer |
|
NUL_Driver_Header |
array[ 0..17 ] of Byte |
|
Description:
List of Lists (LOL), DOS V2.n.
TDOS_LOLv30
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Filler |
array[ 0..3 ] of Byte |
Offset -16 |
Retry_Count |
Word |
Offset -12 |
Retry_Delay |
Word |
Offset -10 |
Current_Disk_Buffer |
Pointer |
Offset -8 |
CON_Input |
Word |
Offset -4 |
Mcb |
Word |
Offset -2 |
Dpb |
Pointer |
Offset 0 |
Sft |
Pointer |
|
CLOCK_Driver |
Pointer |
|
CON_Driver |
Pointer |
|
Device_Count |
Byte |
Offset $10 |
Max_Bytes_Per_Block |
Word |
|
First_Disk_Buffer |
Pointer |
|
Cds |
Pointer |
|
Last_Drive |
Byte |
|
STRING_Workspace |
Pointer |
|
STRING_Size |
Word |
|
Fcb |
Pointer |
|
Protected_FCBs |
Word |
|
NUL_Driver_Header |
array[ 0..17 ] of Byte |
|
Description:
List of Lists (LOL), DOS V3.0.
TDOS_LOLv3
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Filler |
array[ 0..3 ] of Byte |
Offset -16 |
Retry_Count |
Word |
Offset -12 |
Retry_Delay |
Word |
Offset -10 |
Current_Disk_Buffer |
Pointer |
Offset -8 |
CON_Input |
Word |
Offset -4 |
Mcb |
Word |
Offset -2 |
Dpb |
Pointer |
Offset 0 |
Sft |
Pointer |
|
CLOCK_Driver |
Pointer |
|
CON_Driver |
Pointer |
|
Max_Bytes_Per_Block |
Word |
Offset $10 |
First_Disk_Buffer |
Pointer |
|
Cds |
Pointer |
|
Fcb |
Pointer |
|
Protected_FCBs |
Word |
|
Device_Count |
Byte |
|
Last_Drive |
Byte |
|
NUL_Driver_Header |
array[ 0..17 ] of Byte |
|
JOIN_Count |
Byte |
|
Description:
List of Lists (LOL), DOS V3.1+.
TDOS_LOLv4
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Filler |
array[ 0..13 ] of Byte |
Offset -16 |
Mcb |
Word |
Offset -2 |
Dpb |
Pointer |
Offset 0 |
Sft |
Pointer |
|
CLOCK_Driver |
Pointer |
|
CON_Driver |
Pointer |
|
Max_Bytes_Per_Block |
Word |
Offset $10 |
Disk_Buffer |
Pointer |
|
Cds |
Pointer |
|
Fcb |
Pointer |
|
Protected_FCBS |
Word |
|
Device_Count |
Byte |
|
Last_Drive |
Byte |
|
NUL_Driver_Header |
array[ 0..17 ] of Byte |
|
JOIN_Count |
Byte |
|
Program_Names |
Word |
|
IFS_Resident |
Pointer |
|
IFS_Chain |
Pointer |
|
Buffers_X |
Word |
|
Buffers_Y |
Word |
|
Boot_Drive |
Byte |
|
Filler1 |
Byte |
|
Extended_RAM_Size |
Word |
|
Description:
List of Lists (LOL), DOS V4.n.
TDOS_MCB
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Block_Type |
Byte |
|
Owner |
Word |
|
Size |
Word |
|
Filler |
array[ 0..2 ] of Byte |
|
Name |
array[ 0..7 ] of Char |
|
Description:
MCB (Memory Control Block).
TDOS_SFTv2
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Handle_Count |
Byte |
|
Open_Mode |
Byte |
|
Attributes |
Byte |
|
Drive |
Byte |
|
Name |
array[ 0..10 ] of Char |
|
Filler |
array[ 0..1 ] of Word |
|
Size |
Longint |
|
Date |
Word |
|
Time |
Word |
|
Device_Attribute |
Byte |
|
Driver |
Pointer |
|
Absolute_Cluster |
Word |
|
Filler1 |
Word |
|
Current_Position |
Longint |
|
Filler2 |
array[ 0..27 ] of Byte |
|
Start |
Word |
|
Relative_Cluster |
Word |
|
Description:
SFT (System File Table), DOS V2.n.
TDOS_SFTv3
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Handle_Count |
Word |
|
Open_Mode |
Word |
|
Attributes |
Byte |
|
Device_Info |
Word |
|
Driver |
Pointer |
|
Start_Cluster |
Word |
|
Time |
Word |
|
Date |
Word |
|
Size |
Longint |
|
Current_Position |
Longint |
|
Relative_Cluster |
Word |
|
Absolute_Cluster |
Word |
|
Dir_Sector |
Word |
|
Directory_Entry |
Byte |
|
Fcb_Fn |
array[ 0..10 ] of Char |
|
Previous_SFT |
Pointer |
|
Owner |
Word |
|
Sharing_Record |
Word |
|
Description:
SFT (System File Table), DOS V3.n.
TDOS_SFTv4
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Handle_Count |
Word |
|
Open_Mode |
Word |
|
Attributes |
Byte |
|
Device_Info |
Word |
|
Driver |
Pointer |
|
Start_Cluster |
Word |
|
Time |
Word |
|
Date |
Word |
|
Size |
Longint |
|
Redirifs |
Pointer |
|
Filler |
Array[ 0..2 ] of Byte |
|
Fcb_Fn |
Array[ 0..10 ] of Char |
|
Previous_SFT |
Pointer |
|
Machine_Number |
Word |
|
Owner |
Word |
|
Sharing_Record |
Word |
|
Absolute_Cluster |
Word |
|
IFS_Driver |
Pointer |
|
Filler1 |
array[ 0..24 ] of Byte |
|
Relative_Cluster |
Word |
|
Directory_Sector |
Word |
|
Directory_Entry |
Byte |
|
Description:
SFT (System File Table), DOS V4.n.
TDOS_Sharing_Record
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Flag |
Byte |
|
Size |
Word |
|
Checksum |
Byte |
|
Lock_Record |
Word |
|
Sft |
Pointer |
|
Sequence |
Word |
|
Pathname |
Char |
First byte of variable area. |
Description:
Sharing Record.
tDouble_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of Doubles from 0 up to the maximum elements allowed within Max_Memory.
TDPE
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Status |
byte |
0 = inactive, $80 = boot partition |
Start_Head |
byte |
|
Start_Sector_Cylinder |
word |
0:4 = sector, 8: 15,6: 7 = cylinder |
Partition_Type |
byte |
0 = entry not allocated 1 = Primary DOS (FAT12)\ 2 = XENIX 3 = XENIX 4 = Primary DOS (FAT16) 5 = Extended DOS (DOS 3.3) 6 = DOS 4.0 partition with >32 Mb $DB = Concurrent DOS |
End_Head |
byte |
|
End_Sector_Cylinder |
word |
0:4 = sector, 8:15,6:7 = cylinder |
Boot_Sector |
longint |
|
Sectors |
longint |
|
Description:
DPE (Disk Partition Entry).
TDPL
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Ax |
Word |
|
Bx |
Word |
|
Cx |
Word |
|
Dx |
Word |
|
Si |
Word |
|
Di |
Word |
|
Ds |
Word |
|
Es |
Word |
|
Filler |
Word |
|
Id |
Word |
|
Process |
Word |
|
Al |
Byte |
|
Ah |
Byte |
|
Bl |
Byte |
|
Bh |
Byte |
|
Cl |
Byte |
|
Ch |
Byte |
|
Dl |
Byte |
|
Dh |
Byte |
|
Description:
DPL (DOS Parameter List).
TDPS
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Code |
array[ 0..$1BD ] of byte |
|
Partitions |
array[ 0..3 ] of TDPE |
|
ID |
word |
$AA55 (indicates a disk partition sector) |
Description:
DPS ( Disk Partition Sector).
Teditor
File: ueditor.pas
Type: object
Methods:
Name |
Type |
Description |
Variables |
|
|
Anchor |
Anchor_Type |
Current selection anchor. |
Any_Changes |
Boolean |
True if any changes made to buffer. |
Border |
Integer |
Border around edit window. |
Changes |
Boolean |
True if any changes to the current line. |
Current_Line |
Line_Pointer |
Current edit line. |
Cursor_Column |
Integer |
Column cursor sits on (for wide carets) or the one to the right of the caret (for narrow carets). |
Cursor_Row |
Integer |
Current row of cursor. |
End_Of_Buffer_String |
Small_String |
String to show at end of buffer. |
End_Of_Line_Character |
char |
What to show for lines that go off-screen. |
Error_Flag |
Boolean |
True if an error is currently displayed. |
File_Root |
PLine_Buffer |
Root line of buffer. |
Forwards |
Boolean |
True if moving in a forward direction. |
Last_Screen_Line |
Longint |
Previous Screen_Line as of last Redraw |
Logical |
Small_String |
Work variable |
Logical_Column |
Integer |
Current logical column. |
Physical_Column |
Integer |
Current physical column. |
Logical_Text |
String |
Displayed text of current line (including translations). |
Physical_Text |
String |
Actual text of current line. |
Lower_Third_Row |
Integer |
Which row begins the lower third of the display (used for sub-windows). |
Max_Row |
Integer |
Maximum row of display. |
Middle_Row |
Integer |
Middle row of display. |
Upper_Third_Row |
Integer |
Last row of upper third of display (used for sub-windows). |
Options |
Longint |
Processing options. See eds_* |
Quiet_Mode |
Boolean |
|
Screen_Column |
Integer |
Leftmost column visible on display. |
Screen_Line |
Longint |
Line in file corresponding to line 1 of screen |
Screen_Window |
Pwindow |
SMU window used for display. |
Selection |
Boolean |
True if something is selected. |
Selection_Is_Frozen |
Boolean |
True if selection is frozen. |
Tab_Size |
Byte |
Width of tab, in columns. |
Text_Height |
Integer |
Height of text used in display. |
Translation |
Translation_Type |
How to translate characters. |
Window_Height |
Integer |
Height of display window. |
Window_Width |
Integer |
Width of display window. |
Notification_Routine |
Tnotify |
Callback routine. |
Notification_Routine1 |
tEditor_Notify_Event |
DELPHI only. Callback delegation hook. |
Methods |
|
|
Init |
Constructor |
Constructs object. |
Done |
Destructor |
Destructs object. |
Initialize |
n/a |
Initializes editor. This should be the first method called after the constructor. |
Advance |
n/a |
Move cursor one line in the current direction. |
At_EOB |
Boolean |
True if cursor is at the end of buffer. |
At_BOB |
Boolean |
True if cursor is at beginning of buffer. |
At_EOL |
Boolean |
True if cursor is at end of line. |
At_BOL |
Boolean |
True if cursor is at beginning of line. |
Bottom |
n/a |
Moves cursor to end of buffer. |
Calculate_Rows( Height : integer ) |
n/a |
Recalculates max rows and sub-window area when display height changes. |
Change_Case |
n/a |
Changes case of current selection or current character. |
Clear( Draw : boolean ) |
n/a |
Deletes entire buffer contents. If Draw is true, the display is refreshed to reflect the empty buffer. |
Convert_Offset_To_Position( Offset : longint; var Line, Column : longint ) |
n/a |
Return line and column number for the passed character offset. Line and Column are ignored on call, and the converted line and column on return. |
Convert_Position_To_Offset( Line, Column : longint ) |
Longint |
Returns the character offset in the buffer for the passed line and column. |
Copy_Text( Paste_Buffer : pLine_Buffer ) |
n/a |
Copies the selected text into the specified buffer. |
Cursor_Up |
n/a |
Move cursor up one line. |
Cursor_Down |
n/a |
Move cursor down one line. |
Cursor_Left |
n/a |
Move cursor left one character. |
Cursor_Right |
n/a |
Move cursor right one character. |
Delete_Char_Back |
n/a |
Delete one character to left of cursor. |
Delete_Char( Explicit : Boolean ) |
n/a |
Deletes one character at the cursor position. If Explicit is true, the user specifically requested the deletion, otherwise it is implied from some other action. |
Delete_Current_Line |
n/a |
Delete from cursor to EOL |
Delete_Lines( Start, Count : integer ) |
n/a |
Deletes Count lines starting at Start. |
Delete_Text |
n/a |
Delete selected text. |
Delete_Word |
n/a |
Delete from cursor position to next white space. |
Do_Search( Search_Text : string ) |
Boolean |
Search for the specified text. If the string is null, the editor searches for the previous search string. |
Do_Update |
n/a |
Updates the current line. |
EOL |
n/a |
Move cursor to end of current line. |
Fetch_Line( Line_Number : longint ) |
String |
Returns contents of specified line (first line is 0). |
Freeze_Selection |
n/a |
Freezes the current selection. |
Get_Selection_Range( var First_Line, Final_Line : longint ; var First_Column, Final_Column : integer ) |
n/a |
All parameters ignored on call. On return they contain the current selection range. |
Get_Text( T : PChar ) |
n/a |
Return text of entire buffer. |
Half_Page |
n/a |
Moves cursor one-half screen in the current direction. |
Insert_Blank_Line |
n/a |
Inserts a new line at the cursor position. |
Insert_Chars( Character : String ) |
n/a |
Inserts the passed string into the buffer at the current cursor position. |
Lowercase_Word |
n/a |
Changes case of current word. |
Move_Word |
n/a |
Moves to beginning of next word. |
Page |
n/a |
Moves one display worth of lines in the current direction. |
Page_Up |
n/a |
Moves the cursor up one display worth of lines. |
Page_Down |
n/a |
Moves the cursor down one display worth of lines. |
Paste( Paste_Buffer : pLine_Buffer ) |
n/a |
Copies text from passed buffer to the main buffer at the cursor position. |
Position_Caret |
n/a |
Makes sure the current cursor position is visible on the display. |
Position_Cursor( Line, Column : longint ) |
n/a |
Moves the cursor to the specified line and column. |
Redraw( Start : integer ) |
n/a |
Draw (redraw) the display starting at the specified display line. |
Resize |
n/a |
This method is called when the display window size changes so that the editor can recalculate display metrics. |
Screen_To_Text_Column( Line, Column : longint ) |
Longint |
Returns the text column for the passed line and column in the display. |
Scroll_Columns( X : integer ) |
n/a |
Scrolls the display X characters. If X > 0, the display is scrolled left. Otherwise it is scrolled right. |
Search( Search_Text : string ; Start_Line, Start_Column : longint ; var Result_Line, Result_Column : longint ) |
|
Begins a search for the specified text, starting at the specified line and column. If Start_Line is -1, the current cursor line is used. Result_Line and Result_Column are ignored on call. On return they contain the location of the found text. If the text is not found, both Result_Line and Result_Column will be 0. |
Select |
n/a |
Begins a selection. The current cursor position becomes the anchor of the selection. When the selection is frozen, the selection will encompass the text between the anchor and the cursor position at the time the selection is frozen. |
Select_Text( Start_Line, Start_Column, End_Line, End_Column : integer ) |
n/a |
Selects the text between the specified positions. |
Set_Buffer( X : pLine_Buffer ) |
n/a |
Sets the main buffer to the specified buffer. |
Set_Cursor_Column( X : integer ) |
n/a |
Sets the cursor column to X. |
Set_Cursor_Row( X : integer ) |
n/a |
Sets the cursor row to X. |
Set_Line( X : integer ; Y : string ) |
n/a |
Sets the specified line to the specified text. |
Something_Selected |
Boolean |
Returns true if some text is selected. Note that a selection can be active, but have no text selected (anchor and end point are the same). |
Text_Size |
Longint |
Size of all text in main buffer, in bytes. |
Text_To_Screen_Column( Line, Column : longint ) |
Longint |
Returns the display column for the passed physical line and column. |
Top |
n/a |
Moves cursor to the beginning of the main buffer. |
Unselect |
n/a |
Cancels the selection. |
Uppercase_Word |
n/a |
Convert current word to uppercase. |
Word_Backward |
n/a |
Move cursor one word to the left. |
Word_Forward |
n/a |
Move cursor one word to the right. |
Word_Range( var Starting, Ending : integer ) |
n/a |
Starting and Ending are ignored when passed. On return they contain the starting and ending columns of the current word. |
Description:
This class implements a complete text editor.
Teditor_Notify_Event
File: ueditor.pas
Type: type (procedure of object) (Delphi only)
Fields:
Name |
Type |
Description |
X |
Integer |
Type of callback. See edn_* |
Description:
Used as a callback from Teditor.
Teditor_Panel
File: Editor_Panel.pas
Type: Tpanel descendant
Methods/components:
Name |
Type |
Description |
||
Instance data: |
|
|
||
Control_K |
Boolean |
True if in control-K mode. |
||
Control_O |
Boolean |
True if in control-O mode. |
||
Control_Q |
Boolean |
True if in control-Q mode. |
||
Editor |
Peditor |
Editor for which this is an interface. |
||
Mouse_Selection |
Boolean |
True if currently selecting via mouse. |
||
Undo_List |
POperation_Logger |
Logged operations for undo. |
||
Methods: |
|
|
||
_OnKeyDown |
TkeyEvent |
Delegation for key down. |
||
On_Focus |
TnotifyEvent |
Delegation for when panel receives focus. |
||
Bring_Into_View |
n/a |
Forces part of text with caret to come into view. |
||
Cursor_Right |
n/a |
Move the caret one character to the right. |
||
Open( S : string ) |
Boolean |
Reads contents of file whose name is in S, into the current position in the main buffer. |
||
Delete_Text |
n/a |
Delete selected text. |
||
Insert_Buffer( Buffer : pLine_Buffer ) |
n/a |
Inserts the contents of the specified buffer into the current position in the main buffer. |
||
Position_Cursor( Line, Column : integer ) |
n/a |
Positions the caret at the specified line and column. |
||
Search( X : string ;Case_Sensitive : boolean ) |
Boolean |
Searches for the text in X. If Case_Sensitive is true, the search is done with case-sensitively, otherwise case is ignored. |
||
Undo |
n/a |
Undoes the last operation. |
Description:
This control is used to provide a windowed interface to a Teditor object. The parent object must be a TEditor_Window. The following key sequences are supported:
Key(s) |
Description |
|
Indent selected text. |
|
Unindent selected text |
|
Lowercase current word. |
|
Uppercase current word. |
|
Indent selected text. |
|
Select to end of line. |
|
Include a file. |
|
Save changes. |
|
Select current word. |
|
Unindent selected text. |
|
Delete selection. |
|
Open file at cursor. |
|
Change case of selected text. |
|
Replace. |
|
Select to end of text. |
|
Select to end of line. |
|
Select to top of window. |
|
Find. |
|
Select to top of text. |
|
Move to beginning of line. |
|
Select page down. |
|
Select page up. |
|
Select to bottom of window. |
|
Delete line. |
|
New line. |
|
Delete current word. |
|
Delete line. |
|
Undo last operation. |
TEditor_Preferences
File: editpref.pas
Type: dialog (Delphi)
API:
Control |
Type |
Meaning |
Persistant_Selection |
Tcheckbox |
If checked, selections are not canceled when the mouse is clicked. Otherwise, clicking with the mouse cancels the current selection. |
Bounded_Caret |
Tcheckbox |
If checked, the caret cannot move beyond the bounds of the text. |
Inactive_Selection |
Tcheckbox |
If checked, input operations do not replace the current selection, if any. |
Tab_Processing |
Tcheckbox |
If checked, tabs cause positioning. Otherwise, tabs are treated as text characters. |
Sub_Window |
Tcheckbox |
If checked, the window scrolls when the caret moves above 1/3 or below 2/3 of the window height. Otherwise, scrolling only occurs when the caret moves above the top line or below the bottom line. |
Auto_Indent |
Tcheckbox |
If checked, an ENTER will tab to the first text position of the previous line on the new line. |
Wrap_Caret |
Tcheckbox |
If checked, and Bounded_Caret is checked, moving left from the first column will move to the end of the previous line and moving right from the last column of text on a line will move to the first column of the next line. |
Description:
This dialog is used to query the user for editor window options. It is solely a UI component - it does no actual work.
Teditor_Window
File: editwin.pas
Type: Tform descendant
Components/methods:
Name |
Type |
Description |
Components: |
|
|
Main_Menu |
TMainMenu |
Menu for editor window. |
Edit1 |
TmenuItem |
Edit menu item on Main_Menu. |
IncludeFile1 |
TmenuItem |
Include File menu item on Edit1 |
Delete_Menu |
TmenuItem |
Delete menu item on Edit1 |
Paste_Menu |
TmenuItem |
Paste menu item on Edit1. |
Copy_Menu |
TmenuItem |
Copy menu item on Edit1. |
Cut_Menu |
TmenuItem |
Cut menu item on Edit1. |
Undo1 |
TmenuItem |
Undo menu item on Edit1. |
Search1 |
TmenuItem |
Search menu on Main_Menu. |
GotoLineNumber1 |
TmenuItem |
Goto line menu item on Search menu. |
FindNext1 |
TmenuItem |
Find next menu item on Search menu. |
Replace1 |
TmenuItem |
Replace menu item on Search menu. |
Find1 |
TmenuItem |
Find menu item on Search menu. |
Include_Dialog |
TopenDialog |
File open dialog for including file text. |
On_Kill |
TnotifyEvent |
Delegation for when window is destroyed. |
On_Selection_Change |
TnotifyEvent |
Delegation for when selection state changes. |
On_State_Change |
TnotifyEvent |
Delegation for when window becomes focused or modified state changes. |
OnUpdateMenu |
TnotifyEvent |
Called when clipboard contents are changed so that menus/buttons can be updated to reflect the change. |
Active_State |
Boolean |
True if this is an active window. |
New_File |
Boolean |
True if this is a new window, not loaded from a file, nor ever saved to a file. |
StatusBar |
TstatusBar |
The application main status bar to send line/column/modified status to. |
File_Name |
String |
Name of file for the edit text. |
|
|
|
Methods: |
|
|
Active_Selection |
Boolean |
True if something is selected. |
Copy_Text |
String |
Returns the selected text. |
Current_Column |
Integer |
Returns the current caret column. |
Current_Row |
Integer |
Returns the current caret row. |
Delete_Text |
n/a |
Deletes selected text. |
Get_Line( X : integer ) |
String |
Returns text of the specified line. |
Get_Text( T : PChar ) |
n/a |
Returns the text of the entire editor buffer. Note that T must point to a buffer large enough to hold the entire editor buffer. |
Include_File |
n/a |
Prompts the user for a file to include and inserts the text from that file into the current position. |
Include_File( X : string ) |
n/a |
Inserts the text from the specified file (X) into the current position. |
Insert_Text( X : string ) |
n/a |
Inserts the text in the passed string into the current position. |
Max_Line |
Integer |
Returns the highest line number in the buffer. |
Modified |
Boolean |
Returns true if the editor buffer has been modified since loading from/saving to a file. |
Notify( X : integer ) |
n/a |
Pass a notification on. |
Open_File |
n/a |
Prompts the user for a file to open and reads the contents of that file into the buffer. |
Open_File( S : string ) |
n/a |
Opens the passed file and reads the contents of that file into the buffer. |
|
n/a |
Print the buffer. |
Save_File |
n/a |
Saves the buffer contents to the current file. If no file is associated with this buffer, the user is prompted for a filename. |
Search( X : string ) |
Boolean |
Searches for the text in the passed string. Returns true if found, false otherwise. |
Select_Line( X : integer ) |
n/a |
Selects the specified line. |
Set_Preferences |
n/a |
Prompts the user for preferences. |
Text_Size |
Integer |
Returns the size of the entire buffer contents, in bytes. |
Undo |
n/a |
Undoes the last edit operation. |
|
|
|
Properties: |
|
|
Column_Number |
Integer |
Which column number has the caret. |
Line_Number |
Integer |
Which line number has the caret. |
Top_Line |
Integer |
Which buffer line is visible at the top of the window. |
Description:
This class provides a Windows control which is a simplified interface to a Teditor_Panel (and thus, to a Teditor). The delegation hooks allow this window to easily be used in MDI applications.
TEPB
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Environment |
Word |
|
Command_Line |
Pointer |
|
Fcb1 |
Pointer |
|
Fcb2 |
Pointer |
|
Initial_SS_SP |
Longint |
|
Entry_Pointer |
Longint |
|
Description:
EXEC Parameter Block.
tError_Interface
File: uec.h, uehdefs.pas
Type: class (Pascal)
Methods:
Method |
Description |
function Get_Facility : longint ; |
Returns the facility code for the error interface. |
function Get_Name : PChar ; |
Returns the name of the facility for the error interface. |
function Translate_Error( Code : longint ) : PChar ; |
Translates the passed code into a human-readable string. See Translate_Error_Ex. |
procedure Done ; |
Terminates error interface object. |
function Facility_Version : longint ; |
Returns version of facility. |
function Version : longint ; |
Returns the version of the error interface API. |
function Severity( Code : longint ) : longint ; |
Returns the severity of the passed code. |
function Translate_Error_Ex( Code : longint ; var Size, Typ : longint ) : PChar ; |
Returns a human-readable string for the passed error code. Size and Typ are ignored when passed, and contain the Size of the returned string and type error severity code. |
Description:
This class (a Tobject descendant in Borland Pascal) defines the UEH error interface class. All methods are stdcall (except in Borland Pascal).
Teu_Advance
File: teu.c
Type: void function
Parameters: None
Description:
Advance to beginning of next line
Teu_Bottom
File: teu.c
Type: void function
Parameters: None
Description:
Move cursor to the end of the buffer.
Teu_Change_Case
File: teu.c
Type: void function
Parameters: None
Description:
Changes the case of the character at the current cursor position.
Teu_Cut
File: teu.c
Type: void function
Parameters: None
Description:
Cut selected text and put it into the paste buffer.
Teu_Delete_Line() ;
File: teu.c
Type: void function
Parameters: None
Description:
Deletes from the current cursor position to the end of the line, and also deletes the new-line at the end of the line.
Teu_Delete_Word
File: teu.c
Type: void function
Parameters: None
Description:
Delete current word.
Teu_Eol
File: teu.c
Type: void function
Parameters: None
Description:
Move to end of current line.
Teu_Half_Page
File: teu.c
Type: void function
Parameters: None
Description:
Advance one-half page (11 lines).
Teu_Insert_Line
File: teu.c
Type: void function
Parameters: None
Description:
Insert blank line.
Teu_Move_Word
File: teu.c
Type: void function
Parameters: None
Description:
Move to beginning of next word.
Teu_Page
File: teu.c
Type: void function
Parameters: None
Description:
Advance cursor one page (22 lines).
Teu_Paste
File: teu.c
Type: void function
Parameters: None
Description:
Insert text from paste buffer.
Teu_Search
File: teu.c
Type: void function
Parameters: None
Description:
Search for text.
Teu_Select
File: teu.c
Type: void function
Parameters: None
Description:
Begin selection at current position.
Teu_Setup
File: teu.c
Type: void function
Parameters: None
Description:
Should be called before any other TEU functions, except for TEU_TEU.
Teu_Special_Insert
File: teu.c
Type: void function
Parameters: None
Description:
Insert a character by ASCII value.
Teu_Top
File: teu.c
Type: void function
Parameters: None
Description:
Go to top of buffer.
Teu_Undelete_Line
File: teu.c
Type: void function
Parameters: None
Description:
Undelete previously deleted line.
Teu_Unselect
File: teu.c
Type: void function
Parameters: None
Description:
Unselect any selected text.
Teu_Teu
File: teu.c, teu.pas
Type: void function (C), Procedure (Pascal)
Parameters:
Name |
Type |
Description |
Passed_Command |
String |
Filename to edit, including any processing switches. |
Description:
This launches the TEU editor, and returns when the editing is finished.
TEXE_Header
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
ID |
word |
$5A4D |
Length |
longint |
|
Segment_Address_Count |
word |
|
Header_Size |
word |
|
Min_Paragraphs |
word |
|
Max_Paragraph |
word |
|
SS_Displacement |
word |
|
Starting_SP |
word |
|
Checksum |
word |
|
Starting_IP |
word |
|
CS_Offset |
word |
|
RT_Address |
word |
|
Overlay |
word |
|
Description:
EXE File Header.
TExpression_Evaluator
File: express.pas
Type: class (Borland Pascal)
Methods:
Method |
Type |
Description |
Calculate( Operator : integer ) |
Boolean |
Performs the passed operation on the stack values. |
ERT( X : integer ) |
String |
Returns text associated with passed error code. |
Evaluate( X : string ) |
Boolean |
Evaluates the expression in X and returns True if no errors. |
Function_Reference( Value : integer ) |
Boolean |
Process function parameters. Value is the parameter count. |
Get_Position |
Integer |
Returns position of error in passed expression. The result is random if no error occurred in the last evaluation. |
Get_Result |
Extended |
Returns result of last evaluated expression. |
Get_Symbol( X : string ; var Flags, Address, Value, _Result : integer ) |
n/a |
Obtains information on the passed symbol. X is the symbol name. Flags is ignored on call and is the SF_* flags for this symbol on return. Address is ignored on call and is the unique address of this symbol on return. Value is ignored on call and is the number of parameters (for functions only) on return. If Value is negative, the function takes zero to abs( Value ) parameters. |
Last_Error |
Integer |
Returns the error generated by the last evaluation (0 if none). |
Pop |
Extended |
Pops one value from the expression stack. |
Push( F : extended ) |
n/a |
Pushs a value onto the expression stack. |
Put_Token( X : string ) |
n/a |
Returns a token to the front of the token stream. |
Token |
String |
Returns the next token from the expression being evaluated. Returns null if no more expression to be evaluated. |
Description:
This class provides an extensible mathematical expression evaluator. The following table lists the built-in operators, constants, and functions. Note that any of these can be overriden in a descendant.
Operator |
Type |
Precedence |
Description |
|
- |
Left-unary |
Top |
Unary minus |
|
+ |
Left-unary |
Top |
Unary plus |
|
* |
Binary |
24000 |
Multiplication |
|
/ |
Binary |
24000 |
Division |
|
- |
Binary |
16000 |
Subtraction |
|
+ |
Binary |
16000 |
Addition |
|
^ |
Binary |
26000 |
Exponentiation |
|
Min |
Binary |
10000 |
Minimum |
|
Max |
Binary |
10000 |
Maximum |
|
% |
Right-unary |
28000 |
Percentage |
|
! |
Right-unary |
28000 |
Factorial |
|
Mod |
Binary |
24000 |
Modulus division |
|
Rem |
Binary |
24000 |
Remainder of division |
|
D |
Binary |
10000 |
Bell-curve |
|
Div |
Binary |
28000 |
Integer division |
|
|
|
|
|
|
Constant |
Description |
|
|
|
PI |
Pi |
|
|
|
|
|
|
|
|
Function |
Example |
Description |
|
|
Abs |
Abs(n) |
Absolute value of n. |
|
|
Arccos |
Arccos(n) |
Arc cosine of n. |
|
|
Arccot |
Arccot(n) |
Arc cotangent of n. |
|
|
Arccsc |
Arccsc(n) |
Arc cosecant of n. |
|
|
Arcsec |
Arcsec(n) |
Arc secant of n. |
|
|
Arcsin |
Arcsin(n) |
Arc sine of n. |
|
|
Cos |
Cos(n) |
Cosine of n. |
|
|
Cot |
Cot(n) |
Cotangent of n. |
|
|
Csc |
Csc(n) |
Cosecant of n. |
|
|
Deg |
Deg(n) |
Convert n radians to degrees |
|
|
Exp |
Exp(n) |
E^n. |
|
|
Fib |
Fib(n) |
Fibonacci of n. |
|
|
Fix |
Fix(n) |
Integer of n (truncated). |
|
|
Hyparccos |
Hyparccos(n) |
Hyperbolic arc cosine of n. |
|
|
Hyparccot |
Hyparccot(n) |
Hyperbolic arc cotangent of n. |
|
|
Hyparccsc |
Hyparccsc(n) |
Hyperbolic arc cosecant of n. |
|
|
Hyparcsec |
Hyparcsec(n) |
Hyperbolic arc secant of n. |
|
|
Hyparcsin |
Hyparcsin(n) |
Hyperbolic arc sine of n. |
|
|
Hypcos |
Hypcos(n) |
Hyperbolic cosine of n. |
|
|
Hypcot |
Hypcot(n) |
Hyperbolic cotangent of n. |
|
|
Hypcsc |
Hypcsc(n) |
Hyperbolic cosecant of n. |
|
|
Hypsec |
Hypsec(n) |
Hyperbolic secant of n. |
|
|
Hypsin |
Hypsin(n) |
Hyperbolic sine of n. |
|
|
Int |
Int(n) |
Integer of n (rouneded). |
|
|
Log |
Log(n) |
Natural logarithm of n. |
|
|
Log10 |
Log10(n) |
Logarithm, base 10, of n. |
|
|
Rad |
Rad(n) |
Convert n degrees to radians |
|
|
Rnd |
Rnd |
Random number where 0<=n<1 |
|
|
Root |
Root(n, r) |
Rth root of n. |
|
|
Sec |
Sec(n) |
Secant of n. |
|
|
Sgn |
Sgn(n) |
Sign of n (-1, 0, or 1) |
|
|
Sqr |
Sqr(n) |
Square root of n. |
|
|
Tan |
Tan(n) |
Tangent of n. |
|
tExtended_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of Extendeds from 0 up to the maximum elements allowed within Max_Memory.
TextFile
File: typedefs.pas
Type: type (Pascal)
Description:
Synonymous with Text.
Text_Out
File: smu.pas
Type: procedure
Parameters:
Name |
Type |
Description |
Window_P |
Pwindow |
Window to output text to. |
T |
String |
String to output. |
L |
integer |
Length of string to output. |
Description:
Writes the specified text to the cursor position in the specified window.
tFile
File: files.pas
Type: class
Methods:
Method/Variable |
Type |
Description |
BufSize |
Longint |
Size of data buffer. |
BufPos |
Longint |
Position in buffer. |
BufEnd |
Longint |
Current end of buffer. |
BufPtr |
Pchar |
Pointer to data buffer. |
Text_Buffer |
Array[ 0..127 ] of char |
Default file buffer. |
Text_File |
Boolean |
True if accessed as a text file. |
Record_Size |
Trecord_Size |
Size of record, in bytes, for non-text files. |
TUEC |
IO_Error |
Result of last operation. |
Extendable |
Boolean |
True if we can extend the file. |
File_Mode |
Integer |
Mode that file is opened in. |
File_System |
Pfile_System |
Pointer to file system that manages this file. |
Serial_Number |
Longint |
Serial number of this object. |
|
|
|
Init(FS : Pfiel_System ; TF : boolean, Size : longint ) |
constructor |
Constructs the object. TF is true if this is a text file. Size is the size of records in the file, in bytes, for non-text records. |
Done |
Destructor |
Destructs the object. |
Append( const Name : string ) |
N/a |
Opens the file and sets the position to the end of the file. |
Property Attributes |
Longint |
DELPHI ONLY. Property for Get_Attributes and Set_Attributes. |
Blockread( var Buf; Count : Trecord_Size ; var Res: Trecord_Size) |
N/a |
Reads Count records from the current file position into Buf. Res is ignored on call and is the number of full records read upon return. |
Blockwrite( var Buf; Count : Trecord_Size ; var Res: Trecord_Size) |
N/a |
Writes Count records from Buf to the current file position. Res is ignored on call and is the number of full records written upon return. |
Close |
N/a |
Closes the file. |
Debugger |
Pdebug_Interface |
Returns a debug interface to the object. Returns Nil if not supported. |
EOF |
Boolean |
Returns True if the current position is at the end of the file. |
EOLn |
Boolean |
Returns True if the current position is at the end of a line. This causes an error if called for a non-text file. |
Erase( const Name : string ) |
N/a |
Deletes the named file on the file system for this object. |
Facility |
Longint |
Returns the facility code for this class. |
Facility_Name |
String |
Returns the name of the facility for this class. |
FileName |
String |
Returns the name of this file. If the file is not open, an error results. |
FilePos |
Tstore_Size |
Returns the current position in the file, as a record offset (0 is first record). |
Flush |
N/a |
Writes any pending output to the file. Closing the file also flushes it. |
Get_Attributes |
Longint |
Returns the file attributes (see FSFF_*). |
Get_Size |
Tstore |
Returns the size of the file, in records. |
GetFTime( var Time : longint ) |
N/a |
Returns the date/time stamp of the file. |
Initialize |
N/a |
Initializes the object instance. |
Opened |
Boolean |
Returns true if the file is opened. |
Read_Float |
Extended |
Reads a floating-point value from the file and returns it. |
Read_Integer |
Tstore_Address |
Reads an integer value from the file and returns it. |
Read( var Buffer ) |
N/a |
Reads one record from the current position into Buffer. |
Readln( var Buffer : string ) |
N/a |
Reads from current file position to the end of the current line into Buffer. |
Reset( const Name : string ) |
N/a |
Opens the file for I/O. |
Rewrite( const Name : string ) |
N/a |
Deletes the file, and creates a new, empty, one. |
Seek( Pos : Tstore_Address ) |
N/a |
Sets the file position to Pos. |
SeekEOF |
Boolean |
Moves the file position to the end of the file. |
SeekEOLN |
Boolean |
Moves the file position to the end of the current line. |
Set_Attributes( Value : longint ) |
N/a |
Sets the file attributes to Value. |
Set_Extend( State : boolean ) |
N/a |
If State is True, the file can be extended. |
Set_Size( New_Size : Tstore_Size ) |
N/a |
Sets the file size to New_Size. Note that not all file systems support this operation if the New_Size is less than the current file size. Be sure to check the file size after this operation to verify. |
SetFTime( Time : longint ) |
N/a |
Sets the file date/time stamp to Time. |
SetTextBuff( var Buf ; Size : word ) |
N/a |
Sets the internal I/O buffer to the specified buffer, with the specified size, in bytes. |
Truncate( Size : Tstore_Address) |
N/a |
If the file size is greater than Size, the file size is set to Size. Otherwise the size remains unchanged. Note that not all file systems support this operation. See Set_Size. |
Version |
Longint |
Returns the version of the facility for this class. |
Write( var Buffer ) |
N/a |
Writes a record from Buffer to the current file position. |
Writeln( Buffer : string ) |
N/a |
Writes Buffer to the current file position. |
Description:
This descendant of Tstore is used to access file data. Besides the methods inherited from Tstore, it has the above methods for traditional file I/O. Note that none of the class instance data should be modified by the user's code.
Tfile_System
File: files.pas
Type: class
Methods:
Method |
Type |
Description |
Init |
Constructor |
Constructs the object. |
Done |
Destructor |
Destructs the object. |
Attach |
N/a |
Increments the reference count to this object. |
Close( Handle : integer ) |
N/a |
Closes the specified file handle. |
Create( const Name : string ; Mode : integer ) |
Integer |
Create specified file and open with specified mode. If the file already exists, it is deleted and re-created. Returns the file handle of the open file (0 if an error). |
Debugger |
Pdebug_Interface |
Returns a debug interface to this object. Returns nil if not supported. |
Detach |
N/a |
Decrements the reference count to this object. |
DeviceFree( Nam : string ) |
Tstore_Address |
Returns the amount of free space on the specified device for the file system, in bytes. |
DeviceSize( Nam : string ) |
Tstore_Address |
Returns the total size of the specified device for the file system, in bytes. |
Erase( const Name : string ) |
N/a |
Deletes the specified file. |
Facility |
Longint |
Returns the facility ID of the facility for this class. |
File_Name( Handle : integer ) |
String |
Returns the name of the file associated with the specified handle. |
FindFirst( Nam : string; Attributes : longint ; var Find_Record : Tfind_Record ) |
longint |
Starts a wildcard file lookup for the file specification in Nam, with attributes matching Attributes (see FSFF_*). Returns 0 if success. |
FindNext( var Find_Record ) |
Longint |
Finds the next match for the wildcard file lookup associated with Find_Record. Returns 0 if success. |
Flush( Handle : integer ) |
N/a |
Flushes any pending output associated with the file with the specified handle. |
Get_Attributes( Handle : integer ) |
Integer |
Returns the attributes for the file with the specified handle. |
Get_File_Attributes( const Name : string ) |
Longint |
Returns the attributes for the specified file. The file need not be open. |
Get_File_Object( Mode : integer ) |
Pfile |
Returns a pointer to a Tfile object that is compatible with this file system. |
Get_Header( Path : string ; var Header : FS_Header_Information; var Res : TUEC ) |
N/a |
Retrieves file system header information for the specified path. |
Get_Size( Handle : integer ) |
Tstore_Address |
Returns the size of the specified file, in bytes. |
Get_Time( Handle, Typ : integer ) |
Longint |
Returns the date/time stamp for the file. Typ indicates which date/time stamp: |
Initialize_Store( S : PStore ; ID : string ; Flags : longint ; var UEC : tUEC ) ; virtual ; |
N/a |
Initializes the file system on the specified store. ID is a label for the store. Flags indicates the initialization options. UEC is ignored on call, and the result code upon return. |
Last_Error( var Res : TUEC ) |
N/a |
Returns the last error code. |
Lock( Nam : string ) |
Boolean |
Locks the specified device on the file system for exclusive access. Returns True if the calling process was the previously locking process. Note that not all file system support this operation. |
MkDir( Nam : string ) |
Longint |
Creates a directory with the path and name in Nam. Returns 0 if success. |
Open( const Name : stirng ; Mode : integer ) |
Integer |
Opens an existing file with the specified mode. Returns the file handle for this file or 0 if an error. |
Path |
String |
Returns the path of the file system. This is usually null. |
Read( Handle : integer ; Position : TStore_Address ; Len : TStore_Address ; var Buffer ; var Count : TStore_Address ) |
N/a |
Reads from the specified file at the specified position, into Buffer, up to Len bytes. Count is ignored on call. On return, Count contains the actual number of bytes read. |
Rename( const Old, New : string ) |
N/a |
Renames file with name in Old to name in New. |
Set_Attributes( Handle : integer ; Attr : integer ) |
N/a |
Sets the file attributes of the specified file (see FSFF_*). |
Set_File_Attributes( const Name : string ; Value : longint ) |
N/a |
Sets the file attributes of the specified file. The file need not be open. |
Set_Header( Path : string ; var Header : FS_Header_Information ; var Res : TUEC ) |
N/a |
Sets the file system header information for the specified path. Res is ignored on call. On return Res is the result code for the operation. |
Set_Size( Handle : integer ; New_Size : Tstore_Address ) |
N/a |
Sets the size of the specified handle to New_Size bytes. Note that some file systems do not support truncating files. |
Set_Time( Handle : integer ; Typ, Time : longint ) |
n/a |
Sets the date/time stamp for the specified file to Time. Typ is the type of date/time stamp to set. |
Unlock( nam : string ) |
N/a |
Unlocks the file system for the specified device. |
Verify( Name : string ; var Res : TUEC ) |
N/a |
Verifies the file system integrity on the specified device. Res is ignored on call, and is the result code on return. |
Version |
Longint |
Returns the version of the facility for this object. |
Write( Handle : integer ; Position : TStore_Address ; Len : TStore_Address ; var Buffer ; var Count : TStore_Address ) |
N/a |
Writes to the specified file, at the specified position, from Buffer, up to Len bytes. Count is ignored on call and on return is the number of bytes actually written. |
Description:
Tfile_System is a class that encapsulates a file system on any device. Files are identified with integer handles for most methods, and with string names in others.
TFile_System_Server
File: files.pas
Type: class
Methods:
Method |
Type |
Description |
Get_File_System( Store : Pstore ; Own : boolean ) |
Pfile_System |
Creates and returns a file system for the passed store. If there is no known file system on the store, nil is returned. |
Initialize( const Nam, ID : string ; Flags : integer ; var UEC : TUEC ) |
N/a |
Initializes a file system on the specified device, with the specified ID and flags. UEC is ignored when called and the status on return. |
Description:
A Tfile_System_Server serves up a file system.
tFile_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of Files from 0 up to the maximum elements allowed within Max_Memory..
tFile_Parser
File: parse.pas
Type: class
Methods:
Method |
||
Type |
Description |
|
Procedure Close_File |
N/a |
Closes the current file being parsed. The next token will be taken from the previous file. |
Procedure Open_File(Name : string ; F : PFile) |
N/a |
Name is the name of the file to open. If F is nil, a new Pfile is opened. Otherwise, the Pfile object to use to access the data is assumed to be passed in. The previous file being parsed is not closed. Once the new file is closed, the previous file will be parsed continuing where it left off. |
Description:
This descendant of Tparser is used to parse the contents of a file. The above methods are unique to this class.
TFind_Record
File: files.pas
Type: record
Members:
Name |
Type |
Description |
Initialized |
Longint |
0 if this record was initialized. |
Context |
Pwildcard |
For internal use only. |
Separator |
Char |
File list separator (null means none). If not null this character is assumed to delimit multiple paths within the file specification. |
Specification |
String |
Original lookup specification. |
File_Name |
String |
Full name and path of last found file. |
File_List |
String |
List of paths. |
FS |
Pfile_System |
File system being searched. |
Wildcard_Context |
String |
For internal use only. |
Wildcard_Attributes |
Integer |
For internal use only. |
Last_Name |
String |
For internal use only. |
Found_Name |
String |
Name (not including path) of found file. |
Found_Attributes |
Longint |
Attributes (FSFF_* flags) of found file. |
Data |
Array[ 0..511 ] of char |
Context information - file system dependant. |
Description:
This record is used to return information on files during wildcard lookup operations. Although the record members can be use to extract information, none of them should be modified by the user's code, except for Separator.
Theap
File: heap.pas
Type: class
Description:
Theap is a descendant of Tmanaged_Store which uses the standard Delphi memory heap as the store and the allocator.
Time
File: dates.pas, standard.c
Type: string function (Pascal), char* function (C)
Parameters: None
Description:
Returns the current time in "HH:MM xM" format. See also Xtime.
Time_Seconds
File: dates.pas
Type: longint function
Parameters: None
Description:
Returns the time since midnight, in 1/100 seconds.
Time_To_String
File: dates.pas
Type: string function
Parameters:
Name |
Type |
Description |
|
|
String |
Formatting string. |
|
|
longint |
Time since midnight, in 1/100 seconds. |
Description:
Returns the passed time formatted according to the passed format string. See Format_Time for details on the contents of the formatting string.
Tinherited_Debug_Iterator
File: VCLDebug.pas
Type: class
Methods:
Method |
Description |
Procedure Setup |
Sets up children iterators. |
Description:
This is a descendant of the TText_Debugger class. This is the base class for the VCL component debug iterators.
TInput_Source
File: getchars.pas
Type: object (Pascal)
Methods:
Method |
Description |
function Force_Input( S : string ) : boolean |
Forces the specified characters to the source. These are placed ahead of any other data from the source and input requests will take data from the forced input first. Returns true if successful (failure indicates the input buffer size has been exceeded). |
function Force_Special_Input( S : string ) : boolean |
This operates as the Force_Input method, except that only a single key is forced. The value is the same as the values returned by the InKey method. |
function Get_Char( Option : integer ) : char |
Returns the next "raw" character from the input source. This character has no processing performed on it - it is the next low-level data from the source. If Option is 0, the function doesn't return until input is available. Otherwise, it returns immediately. In the second case, it returns a NULL (ASCII 0) if no input is available. |
Constructor Init |
Constructs the object. |
function Inkey : string ; |
Returns a single "cooked" character. It waits until a character is available. Normally this is equivalent to Get_Char( 0 ), but descendant classes may cook characters differently. |
function Pending_Input : boolean |
Returns True if any input is available from the source. |
Description:
This is a descendant of the TIO class, with the above added methods. TInput_Source is the base class for anything which supplies serial input (TStore is for random-access storage).
tInt64_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of Int64s from 0 up to the maximum elements allowed within Max_Memory..
tInteger_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of Integers from 0 up to the maximum elements allowed within Max_Memory..
TInteger_Collection
File: collect.pas
Type: class
Methods:
Method |
Description |
constructor Init( ALimit, ADelta : integer ) ; |
Constructs the object. The collection is pre-allocated for ALimit items. The collection grows in increments of ADelta. Typical values are 0 for ALimit and 4 for ADelta. |
destructor Done ; |
Destructs the object. |
function At( Index : integer ) : longint ; |
Returns the longint at the specified index. If the Index is less than 0 or greater than the maximum current index, 0 is returned. |
function Count : integer ; |
Returns the number of items in the collection. |
function IndexOf( Item : longint ) : integer ; |
Returns the index of the first longint matching Item. If no match is found, the function returns -1. |
function Limit : integer ; |
Returns current limit of collection. |
procedure AtDelete( Index : integer ) ; |
Deletes the item at the specified index. All following items are moved down by one index and the count is reduced by 1. |
procedure AtInsert( Index : integer ; Item : longint ) ; |
Inserts Item at the specified index. |
procedure AtPut( Index : integer ; Value : longint ) ; |
Sets the specified index to the specified value. |
procedure Delete( Item : longint ) ; |
Deletes the specified item. Equivalent to AtDelete( IndexOf( Item ) ) . |
procedure DeleteAll ; |
Deletes all items in the collection. |
procedure Insert( Item : longint ) ; |
Inserts the specified item at the end of the collection. |
procedure SetLimit( ALimit : integer ) ; |
Sets the limit to the specified value. If ALimit is less than Count, the last items in the collection are deleted. |
Description:
This class provides a collection of longint integers. See also TCollection.
Tinteger_List
File: standard.pas
Type: class (Delphi)
Methods:
Method |
Description |
function Add( Value : integer ) : integer ; |
Adds the Value to the end of the list. |
procedure Assign( Source : TInteger_List ) ; |
Copies the source integer list into this list. |
procedure Remove( Value : integer ) ; |
Removes the first instance of the specified value from the list. This reduces the count of the list by 1, if the value is found. |
function IndexOf( Value : integer ) : integer ; |
Returns the index of the first instance of the specified value. If the value is not in the list, -1 is returned. |
procedure Insert( Index, Value : integer ) ; |
Inserts the specified value at the specified index. Value becomes the value at that index, while the previous value at index is now found at index + 1. |
Property Items[ Index : integer ] |
Returns the value at the specified index. |
Description:
This descendant of TList holds a list of longint values.
TIO
File: getchars.pas
Type: object (Pascal)
Methods:
Method |
Description |
procedure Clear |
This method clears any pending I/O. |
Description:
TIO is the base class for all serial I/O sources.
Tline_Buffer
File: ueditor.pas
Type: object
Description:
This class is only used internally in Teditor.
Tline_Number_Dialog
File: linenumb.pas
Type: class (Delphi)
Components:
Component |
Description |
|
Line_Number_Edit: TMaskEdit; |
The edit box used by the user to enter a line number. |
|
OK_Button: TBitBtn; |
"OK" button. |
|
Cancel_Button: TBitBtn; |
"Cancel" button. |
|
Help_Button: TBitBtn; |
"Help" button. |
|
Function Line_Number : integer |
Value of the Line_Number_Edit box. |
Description:
This dialog is used to get a line number from the user.
TLogger
File: loggers.h, loggers.pas
Type: class (C++ and Pascal)
Methods:
Method |
Description |
Procedure Log_Message( Mess : PChar ; Level : integer ; var Abort : boolean ) ; void Log_Message( char* Mess, int Level, bool &Abort) |
This is used to log a message. If Abort is set to true on return, the calling routine should abort its operation. The meaning of Level is described below. Mess contains the text of the message being logged. |
procedure Log_Nested_Message( Mess : PChar ; Level : integer ; var Abort : boolean ) ; void Log_Nested_Message( char* Mess, int Level; bool &Abort) |
This is used to log a message indicating a new state. The Unnest_Message method is called when the state ends. Otherwise, it functions exactly as Log_Message. |
procedure Unnest_Message( Level : integer ; var Abort : boolean ) ; void Unnest_Message( int Level, bool &Abort ) |
This is used to indicate the end of a state whose beginning was signalled via Log_Nested_Message. If Abort is set to true on return, the calling routine should abort its operation. The meaning of Level is described below. |
function Check_Terminate : boolean ; bool Check_Terminate() |
This is used to check if the operation should be aborted. During long operations, a routine should occasionally call this to see if the processing has been aborted by the user. |
Description:
This class is an abstract (pure virtual) class that serves as the ancestor for classes used by other objects to pass information back and forth. Specifically, this is used to log messages and events. In Borland Pascal, this is a static object. In Delphi it is a class. The Delphi and C++ versions use stdcall convention. The Level passed to various methods has whatever meaning is decided between the communicating objects. Some suggested meanings:
Value |
Meaning |
0 |
Undefined |
1 |
Fatal error |
2 |
Serious error |
3 |
Warning |
4 |
Hint |
5 |
Notification |
tLongBool_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of LongBools from 0 up to the maximum elements allowed within Max_Memory.
tLongint_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of Longints from 0 up to the maximum elements allowed within Max_Memory..
tLongword_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of Longwords from 0 up to the maximum elements allowed within Max_Memory.
Tmanaged_Store
File: heap.pas
Type: class
Methods:
Method |
Type |
Description |
Statistics |
Tallocator_Statistics |
Access statistics for this allocator. |
|
|
|
Init |
Constructor |
Constructs the object. |
Done |
Destructor |
Destructs the object. |
Allocate( Size : Tstore_Address) |
Tstore_Address |
Allocates Size bytes and returns the address where the allocation begins. Returns 0 if nothing allocated (usually due to a lack of space or a passed size <= 0). |
Allocate_At( Offset, Size : Tstore_Address ) |
Boolean |
Allocates Size bytes at the specified address (Offset). If the allocation was successful, the function returns True. If Size <= 0, no free space existed for the entire passed range, or the object doesn't support this operation, the function returns False. |
Copy( Source, Destination : TStore_Address ; Count : integer ) |
n/a |
Copies data from the Source address to the Destination address. Count bytes are copied. |
Deallocate( PTR, Size : Tstore_Address ) |
n/a |
Deallocates Size bytes starting at address PTR. |
Fill( PTR : TStore_Address ; Count : integer ; Value : byte ) |
n/a |
Writes the passed Value to the specified address (PTR), for the specified number of bytes (Count). |
Get_Root( var Buf ) |
n/a |
Returns the root of the store into Buf. Note: this is only supported in descendants. |
MaxSpace |
Tstore_Address |
Returns the maximum possible amount of space, in bytes, that can be allocated. |
Read_Heap( PTR, Size : Tstore_Address ; var Buffer ) |
n/a |
Read Size bytes starting at the specified address (PTR) into Buffer. |
Read_Heap( PTR, Size : Tstore_Address ; var Buffer ) |
n/a |
Writes Size bytes from Buffer to the specified address (PTR). |
Reallocate( PTR, Old, New : Tstore_Address) |
Longint |
Efficiently reallocates New bytes of storage to replace the storage at PTR (of Old bytes length). The new address is returned by the function, which may be the same address as the original PTR. |
Set_Root( var Buf ) |
n/a |
Write Buf to the root of the store. Note: this is only supported in descendants. |
SpaceAvail |
Tstore_Address |
Returns the total amount of unused space, in bytes. |
XspaceAvail |
Tstore_Address |
Returns the total amount of unused space, in bytes, plus the amount that the store can be extended (if that is supported). |
Description:
Tmanaged_Store is the base class of all managed store objects. It descends from TStore and provides a managed store of data (allocations and deallocations, reuse of deallocated storage, etc).
TMemory
File: heap.cpp
Type: class
Methods:
Method |
Type |
Description |
Allocate( long int size ) |
long int |
Allocates size bytes of memory and returns the location of the allocation. If the allocation fails, 0 is returned. |
Deallocate( long int PTR, long int size) |
void |
Deallocates size bytes at address PTR. |
MaxSpace() |
long int |
Returns the largest contiguous amount of memory that can be allocated. |
Read_Heap( long int PTR, long int Size, void *Buffer ) |
void |
Reads from the heap into Buffer, size bytes from location PTR. |
SpaceAvail() |
long int |
Returns the total amount of space available to be allocated. |
Write_Heap( long int PTR, long int Size, void *Buffer ) |
void |
Writes size bytes from Buffer to the location PTR. |
Description:
This descendant of Tmanaged_Store encapsulates heap access.
TMemory_Store
File: memstore.pas
Type: type
Methods:
Method |
Type |
Description |
Fix_Size( Size : TStore_Address ) |
n/a |
Sets the size of the store to the passed size and also fixes it. The store cannot be extended via the Extend method after this call. |
Description:
This descendant of Tstore is a contgiuous in-memory store (as opposed to Theap, which is a non-contiguous in-memory store). Besides the methods inherited from Tstore, this class has the above method.
TMP3_Genre
File: Media.pas
Type: Enumeration
Description:
This enumeration defines the music genre as defined in an MP3 file. The values are:
MP3G_Blues
MP3G_Classic_Rock
MP3G_Country
MP3G_Dance
MP3G_Disco
MP3G_Funk
MP3G_Grunge
MP3G_Hip_Hop
MP3G_Jazz
MP3G_Metal
MP3G_New_Age
MP3G_Oldies
MP3G_Other
MP3G_Pop
MP3G_R_B
MP3G_Rap
MP3G_Reggae
MP3G_Rock
MP3G_Techno
MP3G_Industrial
MP3G_Alternative
MP3G_Ska
MP3G_Death_Metal
MP3G_Pranks
MP3G_Soundtrack
MP3G_Euro-Techno
MP3G_Ambient
MP3G_Trip_Hop
MP3G_Vocal
MP3G_Jazz_Funk
MP3G_Fusion
MP3G_Trance
MP3G_Classical
MP3G_Instrumental
MP3G_Acid
MP3G_House
MP3G_Game
MP3G_Sound_Clip
MP3G_Gospel
MP3G_Noise
MP3G_AlternRock
MP3G_Bass
MP3G_Soul
MP3G_Punk
MP3G_Space
MP3G_Meditative
MP3G_Instrumental_Pop
MP3G_Instrumental_Rock
MP3G_Ethnic
MP3G_Gothic
MP3G_Darkwave
MP3G_Techno-Industrial
MP3G_Electronic
MP3G_Pop_Folk
MP3G_Eurodance
MP3G_Dream
MP3G_Southern_Rock
MP3G_Comedy
MP3G_Cult
MP3G_Gangsta
MP3G_Top_40
MP3G_Christian_Rap
MP3G_Pop_Funk
MP3G_Jungle
MP3G_Native_American
MP3G_Cabaret
MP3G_New_Wave
MP3G_Psychadelic
MP3G_Rave
MP3G_Showtunes
MP3G_Trailer
MP3G_Lo_Fi
MP3G_Tribal
MP3G_Acid_Punk
MP3G_Acid_Jazz
MP3G_Polka
MP3G_Retro
MP3G_Musical
MP3G_Rock_n_Roll
MP3G_Hard_Rock
MP3G_Folk
MP3G_Folk_Rock
MP3G_National_Folk
MP3G_Swing
MP3G_Fast_Fusion
MP3G_Bebob
MP3G_Latin
MP3G_Revival
MP3G_Celtic
MP3G_Bluegrass
MP3G_Avantgarde
MP3G_Gothic_Rock
MP3G_Progressive_Rock
MP3G_Psychadelic_Rock
MP3G_Symphonic_Rock
MP3G_Slow_Rock
MP3G_Big_Band
MP3G_Chorus
MP3G_Easy_Listening
MP3G_Acoustic
MP3G_Humor
MP3G_Speech
MP3G_Chanson
MP3G_Opera
MP3G_Chamber_Music
MP3G_Sonata
MP3G_Symphony
MP3G_Booty_Bass
MP3G_Primus
MP3G_Porn_Groove
MP3G_Satire
MP3G_Slow_Jam
MP3G_Club
MP3G_Tango
MP3G_Samba
MP3G_Folklore
MP3G_Ballad
MP3G_Power_Ballad
MP3G_Rhythmic_Soul
MP3G_FreeStyle
MP3G_Duet
MP3G_Punk_Rock
MP3G_Drum_Solo
MP3G_Acapella
MP3G_Euro_House
MP3G_Dance_Hall
MP3G_Goa
MP3G_Drum_n_Bass
MP3G_Club_House
MP3G_Hardcore
MP3G_Terror
MP3G_Indie
MP3G_Britpop
MP3G_Negerpunk
MP3G_Polsk_Punk
MP3G_Beat
MP3G_Christian_Gangsta_Rap
MP3G_Heavy_Metal
MP3G_Black_Metal
MP3G_Crossover
MP3G_Contemporary_Christian
MP3G_Christian_Rock
MP3G_Merengue
MP3G_Salsa
MP3G_Trash_Metal
MP3G_Anime
MP3G_JPop
MP3G_Synthpop
MP3G_Unknown
TMP3_ID3
File: Media.pas
Type: packed record
Fields:
Name |
Type |
Description |
Tag |
array[ 0..2 ] of Char |
Special value. If valid, this is "TAG". |
Title |
Array[ 0..29 ] of char |
Name of artist. |
Comment |
Array[ 0..29 ] of char |
Comments on song. |
Album |
Array[ 0..29 ] of char |
Name of albumn. |
Year |
Array[ 0..3 ] of char |
Copyright year |
Genre |
Byte |
Type of music (see TMP3_Genre). |
Description:
This record defines the last 128 bytes of a .MP3 file. Note that some MP3 files may not have this data (in which case the Tag value will not be "TAG".
TNotify
File: ueditor.pas
Type: type (procedure)
Parameters
Name |
Type |
Description |
X |
Integer |
Type of callback. See edn_*. |
Description:
This callback is used for asynchronous notifications from Teditor.
TNotify_Blink_Event
File: typedefs.pas
Type: type (procedure of object) (Delphi only)
Parameters
Name |
Type |
Description |
Rect |
TRect |
The rectangular region that is being blinked. |
Description:
This delegation hook indicates a blink event (for blinking objects on a display). The indicated Rectangle is being blinked.
tObject
File: common.pas
Type: type (object)
Methods:
Method |
Description |
constructor Init ; |
Creates an instance of the object. |
destructor Done ; |
Destroys the object. |
Procedure Free ; |
Frees and destructs the object. This should only be called for objects allocated on the heap. |
procedure Attach ; |
Increments the reference counter by 1. |
procedure Detach ; |
Decrements the reference counter by 1. If the reference count falls below 1, the object is automatically freed. This should only be called for objects allocated on the heap. |
Description:
Defines the base object from which most classes descend in the subroutine library. The main purpose is to implement reference counting so that many other objects can have pointers to a tObject without being worried about who "owns" the object. Instead, each object with a pointer to a tObject simply attaches to the object when it gets the pointer, and detaches when it is done referencing the object. Once all attachments to the tObject are released, it is automatically freed. Attach and Detach should only be used on objects which are allocated on the heap. In Delphi, tObject does not descend from any other objects. In Borland Pascal, it descends from Objects.TObject.
TOfS
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Offset |
Word |
|
Segment |
Word |
|
Description:
Structure for manipulation of pointers.
tOLEVariant_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of OLEVariants from 0 up to the maximum elements allowed within Max_Memory.
Toperating_System
File: osint.pas
Type: object
Methods:
Method |
Description |
|
function Name : string |
Returns name of operating system. |
|
function Version : string |
Returns version of operating system. For instance "3.1". |
|
function Timestamp : int64 |
Returns current date/time in Sirius format. |
|
procedure Beep( Typ : integer ) |
Sounds a tone. Typ is reserved for future use and should be 0. |
|
procedure Cancel_Typeahead |
Cancels any pending keyboard input. |
|
function Command_Line : string |
Returns the command line used to invoke the program. |
|
function Disk_Clusters( Drive : string ) : int64 |
Returns number of clusters on specified disk drive. Returns -1 if an error or unknown. |
|
function Disk_Sector_Size( Drive : string ) : longint |
Returns the size of sectors on the specified disk drive, in bytes. Returns –1 if an error or unknown. |
|
function Fixed_Device( Device : string ) : boolean |
Returns True if the specified device is fixed (non-removable media). |
|
function Get_Char( Wait : boolean ; var Valid : boolean ) : char ; |
Returns the next waiting character for keyboard input. If Wait is true, the function waits for input if none is ready. Otherwise, the function returns immediately, even if no input is available. Valid is ignored when passed. On return Valid is true if the result is valid (otherwise there was no input to get). |
|
procedure Get_Date( var Year, Month, Day : word ) |
Returns the current date in the passed variables. |
|
function Get_Symbol( const X : string ) : string ; |
Returns the value of the specified symbol (in DOS, this is an environment variable). |
|
procedure Get_Time( var Hour, Minute, Second, Hundreths : word ) |
Returns the current time in the passed variables. |
|
procedure Last_Error( var UEC : TUEC ) ; |
Returns the last error code. |
|
function Media_ID( Device : string ) : longint |
Returns the type of media for the specified device. Returns –1 if unknown or invalid. |
|
function Pending_Input : boolean |
Returns true if any keyboard input is pending. |
|
procedure Print( T : string ) |
Prints the text in T to the default printer. |
|
function PID : longint |
Returns the current Process ID. If not supported by the operating system, this always returns 0. |
|
procedure Reschedule |
Reschedules the current process so other processes can execute. |
|
procedure Spawn( const Path, Parameters : string ) |
Spawns a process. Path is the name of the program (including path) to run. Parameters are the command-line parameters to pass to the program. |
|
function Switch_Delimiter_Count : integer |
Returns the number of valid switch delimiters. |
|
function Switch_Delimiters( Index : integer ) : string |
Returns the switch delimiter for the specified Index. This index should be less than Switch_Delimiter_Count since the first delimiter is at index 0. |
|
function Valid_Device( Device : string ) : boolean |
Returns True if the passed device is valid. |
Description:
Descendants of this class are used to interface to the operating system.
TOperation_Logger
File: operatio.pas, operatio.cpp
Type: class
Instance data:
Data |
Type |
Description |
Root |
Poperation |
Root of operation list. |
Max_Operations |
Integer |
Maximum logged operations allowed. |
Count |
Integer |
Count of logged operations. |
Transaction_Number |
Longint |
Current transaction number. |
Transaction_Type |
Integer |
Current transaction type. |
Original |
Boolean |
True if original operation is on the list. |
Methods:
Method |
Description |
Constructor Init( Max : integer ) |
Constructs the object with the specified maximum of logged operations. |
destructor Done |
Destroys the object. |
procedure Set_Maximum( Max : integer ) |
Sets the maximum logged operations to Max. |
procedure Zero |
Clears all transactions. |
procedure New_Transaction( Typ : integer ) |
Starts a new transaction with the specified type. |
procedure Unwind( Code : integer ) |
Unwinds the last transaction in the list and removes it from the list. |
procedure New_Operation( _ID : Operation_Handler ; Data : pointer ; Size : integer ) void New_Operation(void (id*)(int, void*), void* Data) |
Adds a new operation to the list with the specified Data (of Size bytes), and the operation handler to use when unwinding. |
function Query_Type : integer int Query_Type() |
Returns the type of the last operation in the list. |
Description:
This class is used to log operations and allow undo features. Operations can be collected into groups within transactions. Unwinding (undo) always unwinds an entire transaction. This class can be used in editors, for instance, where each user action is stored as a new transaction. Each transaction may consist of several operations. For instance, a Paste transaction when there is selected text would consist of the following operations: delete old text, insert text from clipboard. Sufficient information must be stored by the caller so that an unwind operation can pass that information back to the Operation handler associated with that operation such that the operation can be undone. When the user wishes to undo, the Unwind method is called and all of the logged operations for the last transaction are unwound, in reverse order. When an operation is unwound, the associated operation handler is called. In the previous example, the insert operation is unwound first, then the delete old text.
TOutline
File: outlines.pas
Type: object
Methods:
Method |
Description |
|
Constructor Init |
Constructs the object. |
|
destructor Done |
Destroys the object. |
|
function Add_Child( Node : POutline_Node ; Text : string ) : POutline_Node |
Adds a child node to Node. If Node is nil, the added node is a top-level node. Text is the text to assign to the new node. The method returns the new node. The child node is always the last at its level. |
|
function Add_Node( Node, Child : POutline_Node ) : POutline_Node |
Adds Child as a child node of Node. Method returns Child. Child is always the last at its level. |
|
function Add_Sibling( Node : POutline_Node ; Text : string ) : POutline_Node |
Add a node as a sibling of the Node. If Node is nil, this adds a top-level child. The child node is always the last at its level. Text is the text of the new node. |
|
procedure Clear |
Clears all nodes in the outline. |
|
function Create_Node : POutline_Node |
Creates an empty node. This allows descendants to create outlines with TOutline_Node descendants. |
|
function Count : integer |
Count of top-level children. |
|
function Find( Text, Delimiter : string ; Wildcards : boolean ) : POutline_Node |
Using the specified path in Text and the delimiter in Delimiter, find a matching node. If Wildcards is true, the Text may contain "*" and "?" for wildcard matching, otherwise all characters are literal. If no match is found, the method returns nil. |
|
function Get_Child( Node : POutline_Node ; Index : integer ) : POutline_Node |
Returns the Indexth child of Node. If Node is nil, the method returns the Indexth top-level child. If Index is out of range, the method returns nil. |
|
function Get_Next( Node : POutline_Node ) : POutline_Node |
Returns the next sibling of Node. If Node is nil, the method returns the first top-level child. If there are no nodes, or Node is the last node at its level, the method returns nil. |
|
function Insert_Child( Node : POutline_Node ; Index : integer ; Text : string ) : POutline_Node |
Inserts a new node as a child of the Node, at position Index in the list (0 is the first). If Node is nil, the child is created as a top-level object. The new node is given the text in Text. The method returns the new node. |
|
function Get_Previous( Node : POutline_Node ) : POutline_Node |
Returns the previous sibling of Node. If Node is nil, the method returns the last top-level child. If there are no nodes, or Node is the first node at its, level the method returns nil. |
|
function Node_With( Text : string ; Wildcards : boolean ) : POutline_Node |
Returns the top-level child node with text matching Text. If Wildcards is true, match on * and ?. The method returns nil if no match is found. |
Description:
This class is used to implement a hierarchical structure (an outline). Each level of the outline consists of a Toutline_Node, optionally with children nodes.
Toutline_Node
File: outlines.pas
Type: object
Instance data:
Name |
Type |
Description |
||
Data |
|
User-defined data can be stored here. |
||
Text |
|
Text for this node. |
Methods:
Method |
Description |
Constructor Init |
Constructs the object. |
destructor Done |
Destroys the object. |
function Add_Child( _Text : string ) : POutline_Node |
Adds a child node. _Text is the text to assign to the new node. The method returns the new node. The child node is always the last at its level. |
function Add_Node( Node : POutline_Node ) : POutline_Node |
Adds Node as a child node. The method returns Node. The child is always the last at its level. |
procedure Clear |
Deletes all children nodes. |
function Count : integer |
Count of top-level children. |
function Create_Outline : Poutline |
Creates a Toutline and reutrns a pointer to it. This is useful when using decendants of both Toutline and Toutline_Node so that all children are collected in the descendant of the Toutline class. |
function Find( _Text, Delimiter : string ; Wildcards : boolean ) : POutline_Node |
Using the specified path in _Text and the delimiter in Delimiter, find a matching node. If Wildcards is true, the Text may contain "*" and "?" for wildcard matching, otherwise all characters are literal. If no match is found, the method returns nil. |
Function Get_Child( Index : integer ) : POutline_Node |
Returns the Indexth child. If Index is out of range, the method returns nil. |
Function Insert_Child( Index : integer ; _Text : string ) : POutline_Node |
Inserts a new child node at position Index in the list (0 is the first). The new node is given the text in Text. The method returns the new node. |
Description:
This class is used for the nodes within a Toutline object.
TOS_DOS
File: os_dos.pas
Type: object
Description:
This Toperating_System descendant provides an interface to DOS and MS Windows Version 3.
TOS_Windows
File: os_windows.pas
Type: object
Description:
This Toperating_System descendant provides an interface to MS Windows (except Windows Version 3).
TOutput_Panel
File: output_panel.pas
Type: type (Delphi)
Method |
Type |
Description |
Canvas |
TCanvas |
Canvas for the output panel. |
On_Paint |
TnotifyEvent |
Delegation hook called when a paint operation occurs. |
Description:
This Tpanel descendant provides a Canvas and On_Paint delegation hook.
TPaint_Notify_Event = procedure( Sender : TObject ; Beginning : Boolean ) of object ;
File: typedefs.pas
Type: procedure of object type (Delphi)
Parameters:
Name |
Type |
Description |
Sender |
Tobject |
Object sending the notification. |
Beginning |
Boolean |
True if beginning a paint, false if ending a paint. |
Description:
This delegation hook is called when a paint operation is beginning or ending. It can be used to disable/enable carets, etc.
TParser
File: parse.pas
Type: class
Methods:
Method |
||
Type |
Description |
|
Constructor Init |
N/a |
Constructs the object. |
Destructor Done |
n/a |
Destructs the object. |
Function Get_Token |
string |
Return next token from source. |
Function Previous_Token_Line |
Integer |
Return previous token line. |
Procedure Push_Token_Line |
N/a |
Push current token line. |
Function Get_Current_Line |
Longint |
Return current token line. |
Function Get_Source |
Pfile |
Returns current token source. |
Function Get_Token_Line |
Longint |
Returns current token line. |
Procedure Set_Source(Value : Pfile) |
N/a |
Sets token source. |
Procedure Add_Special_Token(S : string) |
N/a |
Adds an entry to the special token list. |
Function Grab_Line |
String |
Returns the entire remainder of current line, and moves position to beginning of next line. |
Function Last_Error |
Longint |
Returns last error code. See ParserErr_*. |
Function Token |
String |
Returns the next token from the source. |
Function Token_EOL |
Boolean |
Returns true if at the end of a line. |
Procedure Put_Token(Value : string) |
N/a |
Puts a token back. This will be the next token returned by the Token method. |
Non_Terminals |
String |
A list of characters used to parse tokens. |
Token_Line |
Integer |
The current token line number. |
Description:
The Tparser class is used to parse large amounts of data.
tPChar_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of PChars from 0 up to the maximum elements allowed within Max_Memory.
tPChar_Array
File: Array_Display_Main.pas
Type: class (Delphi)
Methods:
Method |
Type |
Description |
Create( P : PChar ; Len : integer ; RO : boolean ) |
constructor |
Constructs the object, using the specified Pchar, of the specified length, in bytes. RO is true if the data is not to be modified. |
Description:
This descendant of TArray_Interface makes a Pchar accessible as an array.
tPointer_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of pointers from 0 up to the maximum elements allowed within Max_Memory.
tPolygon
File: lines.pas
Type: class (Delphi)
Methods:
Method |
Type |
Description |
Add( X : TPoint ) |
n/a |
Adds another point to the polygon. This point is added at the end of the current point list. |
Generate |
n/a |
Generates the point information for the polygon. |
Generate_Texture_Line( Bitmap, Other : integer ; B_X : boolean ; A, B : TPoint ) |
n/a |
Generate a line of points with matching texture X,Y positions. Bitmap is the size of the side of the texture we are traversing. Other is a constant. B_X is true if we are traversing the X-axis of the bitmap. If Bitmap is negative, we are traversing from the lower right, otherwise from the upper left. If B_X is true, Bitmap is the Width otherwise it is the Height of the texture. Other is the maximum of the other dimension (0, Height, or Width). A and B are the end points for this line in the polygon. |
Line_Count |
Integer |
Number of lines in polygon after generate operation. |
Line_Left( Index : integer ) |
Tpoint |
Point of left side of Indexth line. |
Line_Right( Index : integer ) |
Tpoint |
Point of right side of Indexth line. |
Line_Left_Texture( Index : integer ) |
Tpoint |
Point of left side of Indexth line in texture. |
Line_Right_Texture( Index : integer ) |
TPoint |
Point of right side of Indexth line in texture. |
MinMax |
n/a |
Should be called after one of the generate calls to set up the internal state. |
Vertex_Count |
Integer |
Count of vertecies in polygon. |
Property Vertex[ Index : integer ] |
Tpoint |
Point at given vertex. |
Description:
This descendant of TXY_List has the above additional methods. The polygon can cover an area as large as 65,536 by 65,536 points.
tPSP
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Int_20H |
word |
|
Size |
Word |
|
Reserved |
Byte |
|
FAR_Jump |
array[ 0..4 ] of Byte |
|
Int_22H |
Longint |
|
Int_23H |
Longint |
|
Int_24H |
Longint |
|
Parent |
Word |
|
Files |
array[ 0..19 ] of Byte |
|
Environment |
Word |
|
Ss_Sp |
Longint |
|
Max_Files |
Word |
|
File_Table |
Pointer |
|
Previous_PSP |
Pointer |
|
Filler1 |
array[ 0..19 ] of Byte |
|
Dispatch |
array[ 0..2 ] of Byte |
|
Filler2 |
array[ 0..8 ] of Byte |
|
Fcb1 |
array[ 0..15 ] of Byte |
|
Fcb2 |
array[ 0..19 ] of Byte |
|
Command_Tail |
string[ 127 ] |
|
Description:
PSP (Program Segment Prefix }
Translate_Value
File: cvt.pas
Type: boolean function
Parameters:
Name |
Type |
Description |
Svalue |
String |
Value to translate. |
Flags |
Integer |
Reserved for future use. |
Base |
Var Integer |
Default base (2 to 49, inclusive). The determined base on return. |
Value |
Var int64 |
Ignored on call. The translated value on return. |
Description:
Translates the passed string to an int64 and returns it as well as the base. Unless the passed string has a base modifier, the passed base is assumed to be the base of the passed value. The function returns True if the value was valid, and false otherwise. If the value ends with one of the following characters, and that character is not valid for the passed base, the character is stripped and the value is interpreted as the corresponding base:
Character |
Base |
. |
10 (decimal) |
B |
2 (binary) |
D |
10 (decimal) |
H |
16 (hexadecimal) |
O |
8 (Octal) |
Translation_Type
File: ueditor.pas
Type: type (array[ 0..255 ] of string[ 5 ])
Description:
Defines an array of string translations for Teditor. Each element in the array is used for the ASCII value matching that offset (for instance ASCII 13 used element 13). If the value is null, no translation is done on the character. Otherwise, the contents of the string replace the character.
tReal_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of Reals from 0 up to the maximum elements allowed within Max_Memory.
tReal48_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of Real48s from 0 up to the maximum elements allowed within Max_Memory.
tRect
File: smu.pas
Type: record (non-Windows only)
Fields:
Name |
Type |
Description |
Top |
integer |
Top row of rectangle |
Bottom |
integer |
Bottom row of rectangle |
Left |
Integer |
Left column of rectangle |
Right |
integer |
Right column of rectangle |
Description:
Defines the four points of a rectangle.
TRegisters
File: compatib.pas
Type: type (Delphi)
Description:
Compatible with Borland Pascal Tregisters.
TRecord_Size
File: typedefs.pas
Type: type (Pascal)
Description:
Synonymous to word (Borland Pascal) or Integer (Delphi). Used to specify buffer sizes (such as on Blockread and Blockwrite).
TReplace_Dialog
File: sreplace.pas
Type: class (Delphi)
Interface:
Name |
Type |
Description |
Edit1 |
TeditBox |
Text to search for. |
Edit2 |
TeditBox |
Text with which to replace Edit1 text. |
Case_Sensitive |
TcheckBox |
If checked, the search is done case-sensitively. |
Search_Current |
TradioButton |
If checked, the search begins at the current location. |
Search_Entire |
TradioButton |
If checked, the search begins at the beginning. |
Replace_Prompt |
TcheckBox |
If checked, the user wants to be prompted before each replacement. |
Description:
This is the standard text search-and-replace dialog. It is an interface component only and performs no search or replace itself. It has a Help button which will bring up context help for the value of the form's HelpContext property.
TRequest_Data_Event
File: typedefs.pas
Type: procedure of object (Delphi)
Parameters:
Name |
Type |
Description |
Sender |
Tobject |
Object making delegation call. |
Top |
Boolean |
True to request data from before beginning of current range. False to request data from after end of current range. |
Description:
Delegation handler to request additional data.
TRGB
File: colors.pas
Type: structure
Field |
Type |
Description |
R |
Byte |
Red value |
G |
Byte |
Green value |
B |
Byte |
Blue value |
A |
Byte |
Alpha value |
Description:
This structure defines a 32-bit color definition consisting of 8-bit Red, 8-bit Blue, 8-bit Green, and 8-bit Alpha values.
TRNG
File: randoms.pas
Type: object (Pascal)
Methods:
Method |
Name |
function Generate : longint |
Generates a random number and returns it. |
procedure Randomize |
Generates a random seed value. You must have called the standard Randomize procedure prior to this call to ensure randomness. |
procedure Set_X( X : longint ) |
Sets the seed value. This allows the same sequence of random numbers to be generated when desired. |
function X : longint |
Returns the current seed value. |
Description:
This is a random-number generator using 32-bit seeds. The sequence repeats every 231 values.
TRNG8
File: randoms.pas
Type: object (Pascal)
Methods:
Method |
Name |
Function Generate : byte |
Generates a random number and returns it. |
Procedure Randomize |
Generates a random seed value. You must have called the standard Randomize procedure prior to this call to ensure randomness. |
Procedure Set_X( X : byte ) |
Sets the seed value. This allows the same sequence of random numbers to be generated when desired. |
Function X : byte |
Returns the current seed value. |
Description:
This is a random-number generator using 8-bit seeds. The sequence repeats every 256th value.
TRNG16
File: randoms.pas
Type: object (Pascal)
Methods:
Method |
Name |
function Generate : word |
Generates a random number and returns it. |
procedure Randomize |
Generates a random seed value. You must have called the standard Randomize procedure prior to this call to ensure randomness. |
procedure Set_X( X : word ) |
Sets the seed value. This allows the same sequence of random numbers to be generated when desired. |
function X : word |
Returns the current seed value. |
Description:
This is a random-number generator using 16-bit seeds. The sequence repeats every 65536th value.
TRNG32
File: randoms.pas
Type: object (Delphi)
Methods:
Method |
Name |
function Generate : cardinal |
Generates a random number and returns it. |
procedure Randomize |
Generates a random seed value. You must have called the standard Randomize procedure prior to this call to ensure randomness. |
procedure Set_X( X : cardinal) |
Sets the seed value. This allows the same sequence of random numbers to be generated when desired. |
function X : cardinal |
Returns the current seed value. |
Description:
This is a random-number generator using 32-bit seeds. The sequence repeats every 232 values.
TRNG64
File: randoms.pas
Type: object (Delphi)
Methods:
Method |
Description |
function Generate : int64 |
Generates a random number and returns it. |
procedure Randomize |
Generates a random seed value. You must have called the standard Randomize procedure prior to this call to ensure randomness. |
procedure Set_X( X : int64) |
Sets the seed value. This allows the same sequence of random numbers to be generated when desired. |
function X : int64 |
Returns the current seed value. |
Description:
This is a random-number generator using 64-bit seeds. The sequence repeats every 263 values.
T_SCU
File: scu.h, scuinc.pas
Type: class (C++ and Delphi)
Methods:
Method |
Description |
function Initialize : TUEC ; TUEC Initialize() |
Initializes the SCU database for access. |
procedure Terminate ; void Terminate() |
Terminates the SCU database access. |
function Init( Name : PChar ) : TUEC ; TUEC Init( char* Name ) |
Initializes access to the specified SCU database. |
function Version : longint ; int Version() |
Returns version of SCU object. |
function Write( Path : PChar ; Data : pointer ; Size : longint ) : TUEC ; TUEC Write( char* Path, void* Data, int Size ) |
Writes the specified data of the specified length to the specified path in the current SCU database. |
function Read( Path : PChar ; Data : pointer ; Size : longint ) : TUEC ; TUEC Read( char* Path, void* Data, int Size ) |
Reads from the specified path in the current SCU database and writes the data (up to Size bytes) to the specified buffer. |
function Read_Size( Path : PChar ) : longint ; int Read_Size( char* Path ) |
Returns the size of the specified path in the current SCU database. |
function Read_Type( Path : PChar ) : longint ; int Read_Type( char* Path ) |
Returns the type of the specified path in the current SCU database. |
function Exists( Path : PChar ) : boolean ; bool Exists( char* Path ) |
Returns true if the specified value exists in the current SCU database. |
function Key_Exists( Path : PChar ) : boolean ; bool Key_Exists( char* Path ) |
Returns true if the specified key exists in the current SCU database. |
function Lookup( Path : PChar ; DT : longint ) : PChar ; char* Lookup( char* Path, int DT ) |
Finds a value (wildcards allowed) matching the specified type. |
function Delete( Path : PChar ) : TUEC ; TUEC Delete( char* Path ) |
Deletes the specified path from the current SCU database. |
function Create( Path : PChar ; DT : longint ) : TUEC ; TUEC Create( char* Path, int DT ) |
Creates a new value with the specified type. |
function Create_And_Write( Path : PChar ; DT : longint ; Data : pointer ; Size : longint ) : TUEC ; TUEC Create_And_Write( char* Path, int DT, void* Data, int Size ) |
Creates a new value with the specified type and writes the specified data to it. |
function Rename( Old, New : PChar ) : TUEC ; TUEC Rename( char* Old, char* New ) |
Changes the name of Old path to New. |
function Set_Value( User, Path : PChar ; Data : pointer ; Size : longint ) : TUEC ; TUEC Set_Value( char* User, char* Path, void* Data, int Size) |
Changes the value of the specified user/path to the specified data. |
function Get_Value( User, Path : PChar ; Data : pointer ; Size : longint ) : TUEC ; TUEC Get_Value( char* User, char* Path, void* Data, int Size ) |
Retrieves specified value into buffer. |
function Value_Size( User, Path : PChar ) : longint ; int Value_Size( char* User, char* Path ) |
Returns size of specified value, in bytes. |
function Value_Type( User, Path : PChar ) : longint ; inc Value_Type( char* User, char* Path ) |
Returns type of specified value. |
function Value_Exists( User, Path : PChar ) : boolean ; bool Value_Exists( char* User, char* Path ) |
Returns true if the specified value exists. |
function Delete_Value( User, Path : PChar ) : TUEC ; TUEC Delete_Value( char* User, char* Path ) |
Deletes the specified value. |
function Create_Value( User, Path : PChar ; DT : longint ) : TUEC ; TUEC Create_Value( char* User, char* Path, int DT ) |
Creates the specified value with the specified type. |
function Verify : TUEC ; TUEC Verify() |
Verifies the integrity of the SCU database. |
function Debugger : PDebug_Interface ; TDebug_Interface* Debugger() |
Returns a debugger for the SCU database. |
function Read_Value( User, Path : PChar ; var DT, Size : longint ; var Buffer : PChar) : TUEC ; TUEC Read_Value( char* User, char* Path, int& DT, int& Size, void* Buffer ) |
Reads the specified value. If result indicates a success, DT is the type of the data, Size is the actual data size, and Buffer is a pointer to a buffer containing the data. DT, Size, and Buffer are ignored on call, and set on return. This function serves as a single call to: 1) determine if the value exists, 2) determine what type it is, and 3) read the value's data. |
function Init_And_Extend( Name : PChar ; Size : longint ) : TUEC ; TUEC Init_And_Extend( char* Name, int Size ) |
Initializes access to the specified file. If the file doesn't exist, it is created and pre-extended to the specified size, in bytes. |
function Delete_With_Callback( Path : PChar ; Logger : PLogger ) : TUEC ; TUEC Delete_With_Callback( char* Path, Tlogger* Logger ) |
Deletes the specified value (which can contain wildcards) and logs the operation. |
Description:
This class defines the interface to the SCU utility. All methods use the stdcall convention.
TSAE
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Status |
Byte |
|
Filler |
Byte |
|
Previous_SP |
Word |
|
Previous_SS |
Word |
|
Top |
Word |
|
Description:
SAE (STACKS Array Elements).
TSave_Modified_Dialog
File: saveedit.pas
Type: class (Delphi)
Description:
This dialog is used to indicate that there are unsaved changes. The label named Label1 is the text which will display. The dialog has a help button which will display the help associated with the form's HelpContext property. The dialog returns the following:
Value |
Meaning |
MrYes |
User wants to save changes. |
MrNo |
User wants to discard changes. |
MrCancel |
User wants to cancel the operation. |
TSCB
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Subsegment_Type |
Char |
|
Start |
Word |
|
Size |
Word |
|
Filler |
array[ 0..2 ] of Byte |
|
Name |
array[ 0..7 ] of Char |
|
Description:
SCB (Subsegment Control Block).
TScrolling_Panel
File: scrollpanel.pas
Type: class (Delphi)
Methods:
Method |
Description |
Add_Control( Control : Tcontrol ) |
Adds the specified control to the right of all other children controls on the panel. |
Description:
This descendant of Tpanel shows children controls across its width. If not all the children can show based on the panel's size, scroll buttons are shown that allow the entire collection of controls to scroll left or right.
TSCS
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Filler |
Word |
|
Stacks |
Word |
|
SCB_Size |
Word |
|
Stack_Size |
Word |
|
Data_Segment |
Pointer |
|
Scb |
Word |
|
Last |
Word |
|
Next |
Word |
|
Description:
STACKS Code Segment.
TSDAv3
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Critical_Error_Flag |
Byte |
|
InDOS_Flag |
Byte |
|
Error_Drive |
Byte |
|
Error_Locus |
Byte |
|
Extended_Error_Code |
Word |
|
Suggested_Action |
Byte |
|
Error_Class |
Byte |
|
Error_ES_DI |
Pointer |
|
Current_DTA |
Pointer |
|
Current_PSP |
Word |
|
Stored_SP |
Word |
|
Return_Code |
Word |
|
Current_Drive |
Byte |
|
Break_Flag |
Byte |
|
Swap following only if in DOS |
|
|
Stored_AX |
Word |
|
Sharing_PSP |
Word |
|
Sharing_Number |
Word |
|
First_MB |
Word |
|
Best_MB |
Word |
|
Last_MB |
Word |
|
Filler |
Array[ 0..9 ] of Byte |
|
Dd |
Byte |
|
Mm |
Byte |
|
Yy_1980 |
Word |
|
Dd_1980 |
Word |
|
Day_Of_Week |
Byte |
|
Filler1 |
array[ 0..2 ] of Byte |
|
Driver_Request_Header |
array[ 0..25 ] of Byte |
|
Entry_Point |
Pointer |
|
Driver_Request_Header1 |
array[ 0..21 ] of Byte |
|
Driver_Request_Header2 |
array[ 0..21 ] of Byte |
|
PSP_Type |
Byte |
|
Filler2 |
array[ 0..6 ] of Byte |
|
CLock_Record |
array[ 0..5 ] of Byte |
|
Filler3 |
array[ 0..1 ] of Byte |
|
Fn1 |
array[ 0..127 ] of Char |
|
Fn2 |
array[ 0..127 ] of Char |
|
Sdb |
SDB_Rec |
|
Found_File |
Dir_Rec |
|
Drive_CDSCopy |
Cdsv3 |
|
Fcb_Fn1 |
Array[ 0..10 ] of Char |
|
Filler4 |
Byte |
|
Fcb_Fn2 |
Array[ 0..10 ] of Char |
|
Filler5 |
Array[ 0..8 ] of Byte |
|
Search_Attributes |
Byte |
|
FCB_Type |
Byte |
|
Extended_Attributes |
Byte |
|
Open_Mode |
Byte |
|
Filler6 |
Array[ 0..2 ] of Byte |
|
DOS_Flag |
Byte |
|
Filler7 |
array[ 0..8 ] of Byte |
|
Termination_Type |
Byte |
|
Filler8 |
Byte |
|
Replace_Byte |
Byte |
|
Error_DPB |
Pointer |
|
Stack_Frame |
Pointer |
|
Stored_SP1 |
Word |
|
DPB_Ptr |
Pointer |
|
Filler9 |
array[ 0..7 ] of Byte |
|
Media_ID |
Byte |
|
Filler10 |
array[ 0..4 ] of Byte |
|
Current_SFT |
Pointer |
|
Drive_CDSPTR |
Pointer |
|
Caller_FCB |
Pointer |
|
Filler11 |
Word |
|
Temp |
Word |
|
Jft |
Pointer |
|
Fn1_Csofs |
Word |
|
Fn2_Csofs |
Word |
|
Filler12 |
array[ 0..17 ] of Byte |
|
Current_Offset |
Longint |
|
Filler13 |
array[ 0..11 ] of Byte |
|
Appended |
Longint |
|
Disk_Buffer |
Pointer |
|
Sft |
Pointer |
|
Stored_BX |
Word |
|
Stored_DS |
Word |
|
Temp1 |
Word |
|
Call_Frame |
Pointer |
|
Ren_SrcFile |
SDB_Rec |
|
Ren_File |
Dir_Rec |
|
Error_Stack |
array[ 0..330 ] of Byte |
|
Disk_Stack |
array[ 0..383 ] of Byte |
|
Char_Stack |
array[ 0..383 ] of Byte |
|
Description:
SDA (Swappable DOS Area), DOS 3.n.
TSDAv33
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Critical_Error_Flag |
Byte |
|
InDOS_Flag |
Byte |
|
Error_Drive |
Byte |
|
Error_Locus |
Byte |
|
Extended_Error_Code |
Word |
|
Suggested_Action |
Byte |
|
Error_Class |
Byte |
|
Error_ES_DI |
Pointer |
|
Current_DTA |
Pointer |
|
Current_PSP |
Word |
|
Stored_SP |
Word |
|
Return_Code |
Word |
|
Current_Drive |
Byte |
|
Break_Flag |
Byte |
|
{Swap following only if in DOS} |
|
|
Stored_AX |
Word |
|
Sharing_PSP |
Word |
|
Sharing_Number |
Word |
|
First_MB |
Word |
|
Best_MB |
Word |
|
Last_MB |
Word |
|
Filler |
Array[ 0..9 ] of Byte |
|
Dd |
Byte |
|
Mm |
Byte |
|
Yy_1980 |
Word |
|
Dd_1980 |
Word |
|
Day_Of_Week |
Byte |
|
Filler1 |
Array[ 0..2 ] of Byte |
|
Driver_Request_Header |
Array[ 0..25 ] of Byte |
|
Entry_Point |
Pointer |
|
Driver_Request_Header1 |
Array[ 0..21 ] of Byte |
|
Driver_Request_Header2 |
Array[ 0..21 ] of Byte |
|
PSP_Type |
Byte |
|
Filler2 |
array[ 0..6 ] of Byte |
|
CLOCK_Record |
array[ 0..5 ] of Byte |
|
Filler3 |
array[ 0..1 ] of Byte |
|
Fn1 |
array[ 0..127 ] of Char |
|
Fn2 |
array[ 0..127 ] of Char |
|
Sdb |
SDB_Rec |
|
Found_File |
Dir_Rec |
|
Drive_CDSCopy |
Cdsv3 |
|
Fcb_Fn1 |
array[ 0..10 ] of Char |
|
Filler4 |
Byte |
|
Fcb_Fn2 |
array[ 0..10 ] of Char |
|
Filler5 |
array[ 0..8 ] of Byte |
|
Search_Attributes |
Byte |
|
FCB_Type |
Byte |
|
Extended_Attributes |
Byte |
|
Open_Mode |
Byte |
|
Filler6 |
array[ 0..2 ] of Byte |
|
DOS_Flag |
Byte |
|
Filler7 |
array[ 0..8 ] of Byte |
|
Termination_Type |
Byte |
|
Filler8 |
Byte |
|
Replace_Byte |
Byte |
|
Error_DPB |
Pointer |
|
Stack_Frame |
Pointer |
|
Stored_SP1 |
Word |
|
DPB_Ptr |
Pointer |
|
Filler9 |
array[ 0..7 ] of Byte |
|
Media_ID |
Byte |
|
Filler10 |
array[ 0..4 ] of Byte |
|
Current_SFT |
Pointer |
|
Drive_CDSPTR |
Pointer |
|
Caller_FCB |
Pointer |
|
Filler11 |
Word |
|
Temp |
Word |
|
Jft |
Pointer |
|
Fn1_Csofs |
Word |
|
Fn2_Csofs |
Word |
|
Filler12 |
array[ 0..17 ] of Byte |
|
Current_Offset |
Longint |
|
Filler13 |
array[ 0..11 ] of Byte |
|
Appended |
Longint |
|
Disk_Buffer |
Pointer |
|
Sft |
Pointer |
|
Stored_BX |
Word |
|
Stored_DS |
Word |
|
Temp1 |
Word |
|
Call_Frame |
Pointer |
|
Ren_SrcFile |
SDB_Rec |
|
Ren_File |
Dir_Rec |
|
Error_Stack |
array[ 0..330 ] of Byte |
|
Disk_Stack |
array[ 0..383 ] of Byte |
|
Char_Stack |
array[ 0..383 ] of Byte |
|
Flag |
Byte |
|
Drive |
Byte |
|
Filler14 |
Word |
|
Description:
SDA (Swappable DOS Area), DOS 3.3.
TSDAv4
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Critical_Error_Flag |
Byte |
|
InDOS_Flag |
Byte |
|
Error_Drive |
Byte |
|
Error_Locus |
Byte |
|
Extended_Error_Code |
Word |
|
Suggested_Action |
Byte |
|
Error_Class |
Byte |
|
Error_ES_DI |
Pointer |
|
Current_DTA |
Pointer |
|
Current_PSP |
Word |
|
Stored_SP |
Word |
|
Return_Code |
Word |
|
Current_Drive |
Byte |
|
Break_Flag |
Byte |
|
Filler |
array[ 0..1 ] of Byte |
|
{Swap following only if in DOS} |
|
|
Stored_AX |
Word |
|
Sharing_PSP |
Word |
|
Sharing_Number |
Word |
|
First_MB |
Word |
|
Best_MB |
Word |
|
Last_MB |
Word |
|
Filler1 |
array[ 0..9 ] of Byte |
|
Dd |
Byte |
|
Mm |
Byte |
|
Yy_1980 |
Word |
|
Dd_1980 |
Word |
|
Day_Of_Week |
Byte |
|
Filler2 |
array[ 0..2 ] of Byte |
|
Driver_Request_Header |
array[ 0..29 ] of Byte |
|
Entry_Point |
Pointer |
|
Driver_Request_Header1 |
array[ 0..21 ] of Byte |
|
Driver_Request_Header2 |
array[ 0..29 ] of Byte |
|
Filler3 |
array[ 0..5 ] of Byte |
|
CLOCK_Record |
array[ 0..5 ] of Byte |
|
Filler4 |
array[ 0..1 ] of Byte |
|
Fn1 |
array[ 0..127 ] of Char |
|
Fn2 |
array[ 0..127 ] of Char |
|
Sdb |
SDB_Rec |
|
Found_File |
Dir_Rec |
|
Drive_CDSCopy |
Cdsv4 |
|
Fcb_Fn1 |
array[ 0..10 ] of Char |
|
Filler5 |
Byte |
|
Fcb_Fn2 |
array[ 0..10 ] of Char |
|
Filler6 |
array[ 0..10 ] of Byte |
|
Search_Attributes |
Byte |
|
Open_Mode |
Byte |
|
Filler7 |
array[ 0..2 ] of Byte |
|
DOS_Flag |
Byte |
|
Filler8 |
array[ 0..8 ] of Byte |
|
Termination_Type |
Byte |
|
Filler9 |
array[ 0..2 ] of Byte |
|
Error_DPB |
Pointer |
|
Stack_Frame |
Pointer |
|
Stored_SP1 |
Word |
|
DPB_Pointer |
Pointer |
|
Disk_Buffer |
Word |
|
Filler10 |
array[ 0..7 ] of Byte |
|
Media_ID |
Byte |
|
Filler11 |
Byte |
|
Filler12 |
Pointer |
|
Current_SFT |
Pointer |
|
Drive_CDSPTR |
Pointer |
|
Caller_FCB |
Pointer |
|
Filler13 |
array[ 0..3 ] of Byte |
|
Jft |
Pointer |
|
Fn1_Csofs |
Word |
|
Fn2_Csofs |
Word |
|
Filler14 |
array[ 0..11 ] of Byte |
|
Directory_Cluster |
Word |
|
Filler15 |
array[ 0..9 ] of Byte |
|
Offset |
Longint |
|
Filler16 |
Word |
|
Partial_Bytes |
Word |
|
Sectors |
Word |
|
Filler17 |
array[ 0..5 ] of Byte |
|
Appended_Bytes |
Longint |
|
Disk_Buffer1 |
Pointer |
|
Sft1 |
Pointer |
|
Store_BX |
Word |
|
Store_DS |
Word |
|
Temp |
Word |
|
Previous_Call_Frame |
Pointer |
|
Filler18 |
array[ 0..4 ] of Byte |
|
Filler19 |
Pointer |
|
Special_Open_Action |
Word |
|
SPop_Attr |
Word |
|
SPop_Mode |
Word |
|
Filler20 |
array[ 1..9 ] of Byte |
|
Save_DS |
Word |
|
Filler21 |
array[ 0..4 ] of Byte |
|
Filename |
Pointer |
|
Filler22 |
Pointer |
|
Ssve_SS |
Word |
|
Save_SP |
Word |
|
Stack_Switch |
Byte |
|
Ren_SrcFile |
SDB_Rec |
|
Ren_File |
Dir_Rec |
|
Error_Stack |
array[ 0..330 ] of Byte |
|
Disk_Stack |
array[ 0..383 ] of Byte |
|
Char_Stack |
array[ 0..383 ] of Byte |
|
AH_Flag |
Byte |
|
Drive |
Byte |
|
Flag |
Byte |
|
Filler23 |
array[ 0..8 ] of Byte |
|
Description:
SDA (Swappable DOS Area), DOS 4.n.
TSDB
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Drive_Letter |
Byte |
|
Search_Template |
array[ 0..10 ] of Char |
|
Search_Attributes |
Byte |
|
Directory_Entry |
Word |
|
Parent_Cluster |
Word |
|
Filler |
array[ 1..4 ] of Byte |
|
Found_Attribute |
Byte |
|
Time |
Wor |
|
Date |
Word |
|
Size |
Longint |
|
Name |
array[ 0..12 ] of Char |
|
Description:
SDB (Search Data Block).
TSDB_Rec
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Drive_Letter |
Byte |
|
Search_Template |
array[ 0..10 ] of Char |
|
Search_Attributes |
Byte |
|
Directory_Entry |
Word |
|
Parent_Cluster |
Word |
|
Filler |
array[ 1..4 ] of Byte |
|
Description:
FindFirst/Next data block for SDAs.
TSearch_Dialog
File: ssearch.pas
Type: class (Delphi)
Interface:
Name |
Type |
Description |
Search_Current |
TradioButton |
If checked, this indicates to search from the current cursor position. |
Search_Entire |
TradioButton |
If checked, this indicates to search from the beginning of the text. |
Case_Sensitive |
TcheckBox |
If checked, this indicates to do the search case-sensitive. |
Edit1 |
Tedit |
This edit box contains the text entered by the user. |
Description:
This is a standard text search dialog. The class is a descendant of Tform. The form has a help button which calls up help for the value assigned to the form's HelpContext property.
tShortInt_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of ShortInts from 0 up to the maximum elements allowed within Max_Memory.
tSingle_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of Singles from 0 up to the maximum elements allowed within Max_Memory.
TSizable_Speed_Button
File: sizable_speed_button.pas
Type: class (Delphi)
Description:
This class is a descendant of the VCL TspeedButton. It automatically scales the bitmap glyph as the button is resized.
tSmall_String_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of pSmall_Strings from 0 up to the maximum elements allowed within Max_Memory.
TSN_Record
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Level |
Word |
|
Serial_Number |
Longint |
|
Volume_Label |
array[ 0..10 ] of Char |
|
File_System |
array[ 0..7 ] of Char |
|
Description:
Disk Serial Number Record.
TSpell_Checker
File: spellchk.pas
Type: object (Pascal)
Methods:
Method |
Type |
Description |
Add_Word( S : integer ; X : string ) |
n/a |
S indicates the word set to add to (0-based). X is the word to add. Note that X may be more than one word. If S is greater than the number of word sets defined, the function does nothing. X should not contain ASCII 255. |
Check( X : string ) |
Boolean |
Checks to see if X qualifies as a word and returns True if it does. To qualify, the text must only contain alphabetic characters, dash, and apostrophes. |
Define_Set( X : string ) |
n/a |
X contains the name of a file from which to load. A new word set is created and the words are loaded into that set. If X is null, an empty word set is created. The format of the file, if specified, is one entry per line (CRLF delimited). The file should not contain ASCII 255. If a file is specified but cannot be loaded, the function creates an empty word set. |
Is_Word( X : string ) |
boolean |
Checks the word in X against all defined words in all sets. Returns True if the word is found, and false otherwise. |
Description:
This descendant of Tobject is used for spell checking text. It can, of course, be used for general string matching. The class allows for multiple sets of words (up to 127). Each set can contain as many words as there is available memory - however, no single word entry can be greater than 254 bytes.
TStore
File: heap.pas
Type: class
Methods:
Name |
Type |
Description |
Store_Statistics |
Tstore_Statistics |
Access statistics for this store. |
|
|
|
Contiguous_Store |
Boolean |
Returns True if the store's addresses are contiguous (non-sparse). |
Debugger |
Pdebug_Interface |
Returns a debugger interface for this object. If not supported, it returns nil. |
Extend( Amount : Tstore_Address) |
Tstore_Address |
Requests extension of store by the amount specified. Returns the amount actually added to store. If Amount is 0, function returns 0 if store is extendable, and -1 if it is not. |
Extended_Size |
Tstore_Address |
Returns the maximum theoretical size that the store can be extended to. If the store is not extendable, this returns the same value as Max_Storage. |
Format |
n/a |
Does a low-level format of the store. |
Get_Cache |
Pcache |
Returns the current cache object. |
Get_Name |
String |
Returns the name of the store. |
Initialize |
n/a |
Initializes the object. |
Max_Storage |
Tstore_Size |
Returns the maximum (current) size of the store, in bytes. In other words, this is the highest valid address (plus 1). |
Min_Storage |
Tstore_Address |
Returns the minimum atomic size of the store. For instance, this would be the sector size for a disk. |
Read_Data( var Data ; Address, _Size : TStore_Address ; var UEC : TUEC ) |
Tstore_Address |
Read data from specified Address in store to Data. Reads _Size bytes. Returns success of operation in UEC. Function returns the number of bytes actually read. |
Read_Only |
Boolean |
Returns True if the store can only be read from. |
Set_Cache( Value : Pcache ) |
n/a |
Sets the current cache object. The cache object is used to cache data read and written from/to the store. If Value is nil, data caching is disabled. |
Set_Max_Storage( Value : TStore_Address ; var Res : TUEC ) |
n/a |
Sets the maximum (current) size of the store, in bytes. In other words, this is the new highest valid address (plus 1). If the store is not resizable, the call fails and an error code is returned in Res. This should only be used to shrink the size of the store, not to extend it. To extend, use the Extend method. |
Terminate |
n/a |
Terminates the object. |
Write_Data( var Data ; Address, _Size : TStore_Address ; var UEC : TUEC |
TStore_Address |
Write data from Data to specified Address in store. Writes _Size bytes. Returns success of operation in UEC. Function returns the number of bytes actually written. |
Write_Only |
Boolean |
Returns True if the store can only be written to. |
Description:
TStore is the base class for all storage-related classes. It is an unmanaged store, meaning that it serves as a simple holder for data. See Tmanaged_Store for a managed store.
TStore_Heap
File: Storheap.pas
Type: object
Methods:
Name |
Type |
Description |
Public instance data: |
|
|
AT |
TAT |
Allocation table object used to manage the heap. |
Store_Heap_Store |
Pstore |
The store which is managed by this heap. |
Allow_Cache |
Boolean |
True if the AT is cached in memory. |
Device |
Integer |
File device. |
Flags |
Integer |
Processing flags (see SHF_*) |
Memory |
pAllocator |
Where to allocate cached data. |
Own_Allocator |
Boolean |
True if we own Memory. If true, we destruct the Memory object when we destruct. |
Resolution |
Longint |
Minimum allocation size, in bytes. |
Serial_Number |
Longint |
Serial number of this instance. |
Store_Heap_Statistics |
Tstore_Heap_Statistics |
Store Heap access statistics. |
Extension_Resolution |
longint |
Minimum amount to extend file by, in percentage of file size. |
Last_Error |
TUEC |
Last error status. |
Lowest_Dynamic |
Tstore_Address |
Lowest modifiable address. |
|
|
|
Methods: |
|
|
Init( Minimum, F : integer ; const Name : string ; var _Result : tUEC ; Mem : pAllocator ) |
Constructor |
Constructs the object with the specified minimum resolution. F is processing flags (see SHF_*). Name is the name of the store. The constructor will open the store, if it exists, or create it if not. Mem is the memory heap object to use to manage the dynamic memory needs of the object. _Result is ignored on call, and contains the result of the construction on return. |
Init_On_Store( Minimum, F : integer ; S : PStore ; var _Result : tUEC ; Mem : pAllocator ) |
Constructor |
Constructs the object with the specified minimum resolution. F is processing flags (see SHF_*). S is the store which this object is to manage. Mem is the memory heap object to use to manage the dynamic memory needs of the object. _Result is ignored on call, and contains the result of the construction on return. |
Determine_AT_Metrics( var UEC : TUEC ) |
N/a |
Determines location and size of allocation table on an existing store, setting up the object for managed heap access. |
New( Size : Tstore_Address ) |
N/a |
Creates a new heap on the store, if it is empty, of size Size bytes. |
Path |
String |
Returns the name of the store managed by this heap. |
Debugger |
Pdebug_Interface |
Returns a debugger for this object. |
Set_Cache_Flag( Flag : boolean ) |
N/a |
Turns caching of the allocation table on or off. |
Valid_Data_Address( Address : Tstore_Address ) |
Boolean |
Returns true if the passed address is "valid". The address is valid if it is within the store, not within the allocation table, and not within the root. |
Write_Cache |
N/a |
Flushes the allocation table cache to the store. |
Description:
This descendant of Tmanaged_Store provides a managed heap on a Tstore.
TStore_Heap_Statistics
File: Storheap.pas
Type: type (record)
Fields:
Name |
Type |
Description |
Index_Reads |
Longint |
Cached index physical read count. |
Index_Writes |
Longint |
Cached index physical write count. |
Index_Cache_Hits |
longint |
Number of index reads that were cached. |
Description:
This record is used to store access statistics for Tstore_Heap objects.
TSR
File: tsrs.pas
Type: procedure
Parameters: None
Description:
This procedure terminates the program but keeps it resident in memory (TSR = Terminate and Stay Resident). DOS only.
TStore_Address
File: heap.pas
Type: type [int64 (Delphi), Comp or longint (Pascal)]
Description:
This type is used as a parameter to Tstore methods where an address into the store is needed. If the Pointer64 conditional compilation symbol is set in Borland Pascal, this is a Comp. Otherwise it is a longint (Borland Pascal). In Delphi it is always an int64.
Tstore_Server
File: files.pas
Type: class
Methods:
Method |
Type |
Description |
Get_Store( var Name : string ) |
Pstore |
Creates and returns a Tstore object for the passed specification. On return, Name has the device ID stripped from it. If there is no store available, nil is returned. |
Get_Store_ID( name : string ) |
String |
Returns the portion of Name which is the ID of the store. |
Description:
A Tstore_Server serves Tstore objects.
TStore_Size
File: heap.pas
Type: type [int64 (Delphi) or longint (Borland Pascal)]
Description:
This type is used for Tstore method parameters where a size or count is required.
TStore_Statistics
File: heap.pas
Type: record
Members:
Name |
Type |
Description |
Bytes_Read |
Longint |
Count of bytes read. |
Bytes_Written |
Longint |
Count of bytes written. |
Reads |
Longint |
Number of read operations. |
Writes |
Longint |
Number of write operations. |
Error_Count |
Longint |
Error count. |
Description:
This record is used to store statistics on the use of a Tstore.
tString_Array
File: typedefs.pas
Type: type
Description:
Defines an array of pStrings from 0 up to the maximum elements allowed within Max_Memory.
TString_Collection
File: collect.pas
Type: class
Methods:
Method |
Description |
constructor Init( ALimit, ADelta : integer ) ; |
Constructs the object. The collection is pre-allocated for ALimit items. The collection grows in increments of ADelta. Typical values are 0 for ALimit and 4 for ADelta. |
destructor Done ; |
Destructs the object. |
function At( Index : longint ) : string ; |
Returns the string at the specified index. If the Index is less than 0 or greater than the maximum current index, a null string is returned. |
function Count : integer ; |
Returns the number of strings in the collection. |
function IndexOf( Item : string ) : integer ; |
Returns the index of the first string matching Item. If no match is found, the function returns -1. |
function Limit : integer ; |
Returns current limit of collection. |
procedure AtDelete( Index : integer ) ; |
Deletes the item at the specified index. All following items are moved down by one index and the count is reduced by 1. |
procedure AtInsert( Index : integer ; Item : string ) ; |
Inserts string at the specified index. |
procedure AtPut( Index : integer ; Value : string ) ; |
Sets the specified index to the specified string. |
procedure Delete( Item : string ) ; |
Deletes the specified string. Equivalent to AtDelete( IndexOf( Item ) ) . |
procedure DeleteAll ; |
Deletes all strings in the collection. |
procedure Insert( Item : string ) ; |
Inserts the specified string at the end of the collection. |
procedure SetLimit( ALimit : integer ) ; |
Sets the limit to the specified value. If ALimit is less than Count, the last strings in the collection are deleted. |
Description:
This class provides a collection of strings. See also TCollection and TInteger_Collection.
Tsub_Heap
File: heap.pas
Type: class (Delphi)
Methods:
Method |
Type |
Description |
SpaceAvail |
Longint |
Amount of space available in sub-heap, though not necessarily contiguous. |
Resolution |
Longint |
Minimum heap allocation size, in bytes. This should never be modified. |
|
|
|
Init( Size, Res : longint ) |
Constructor |
Initializes the sub-heap with a total size of Size bytes, and a minimum allocation resolution of Res bytes. |
Done |
Destructor |
Destructs the object. |
Allocate( Size : longint ) |
longint |
Allocates Size bytes and returns the address of the allocation. If nothing was allocated, 0 is returned. Allocation can fail if the Size <= 0 or if there is not enough room for the allocation. |
Deallocate( PTR, Size : longint ) |
n/a |
Deallocates Size bytes starting at the specified address (PTR). |
Description:
This class is used to create independent heaps which can be allocated from. This can be used when different heaps are needed for different types of data (such as small allocations in one and large allocations in another) to reduce fragmentation. It can also be used to reduce the number of memory selectors used to map large amounts of virtual memory.
tText_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of Texts from 0 up to the maximum elements allowed within Max_Memory.
tTexture
File: lines.pas
Type: class (Delphi)
Methods:
Name |
Type |
Description |
Height |
Integer |
Height of texture, in pixels. |
Width |
Integer |
Width of texture, in pixels. |
_Array |
PInteger_Array |
Texture image. |
|
|
|
Load_From_Bitmap( Bitmap : TBitmap ) |
n/a |
Loads the texture from a bitmap. |
Description:
This class encapsulates a texture which can be used with various graphics primitives.
TSymbol_Deletion_Logger
File: symbols.pas
Type: object (Pascal)
Methods:
Method |
Type |
Description |
Deletion_Notification( Symbol : PSymbol_Entry ) |
n/a |
Called when the passed symbol is about to be deleted from the symbol table. |
Description:
Objects of this class are used by Tsymbol_Table objects to provide notification of a symbol deletion.
TSymbol_Entry
File: symbols.pas
Type: record
Members:
Name |
Type |
Description |
Name |
^(string[255]) |
Name of symbol. Should not be modified by the user. If a symbol name must change, delete the old symbol and add the new symbol - otherwise, the symbol table can become corrupted. |
Address |
Longint |
Address of symbol. |
Flags |
Longint |
Flags for symbol. |
Data_Type |
Longint |
Data type for symbol. |
Size |
Longint |
Size of symbol, in bytes. |
B_Link |
Psymbol_Entry |
Link to parent node in symbol table. NOTE: this is managed solely by the symbol table and must not be modified by the application. |
L_Link |
Psymbol_Entry |
Link to left child node in symbol table. NOTE: this is managed solely by the symbol table and must not be modified by the application. |
R_Link |
Psymbol_Entry |
Link to right child node in symbol table. NOTE: this is managed solely by the symbol table and must not be modified by the application. |
Data |
Pointer |
Pointer to additional symbol information. |
Description:
This structure is used to define a symbol that is stored in a Tsymbol_Table object. Note that all elements are user-defined, except the four items noted.
TSymbol_Table
File: symbols.pas
Type: class (Delphi)
Methods:
Method |
Type |
Description |
Init( Delete_Logger : PSymbol_Deletion_Logger ) |
Constructor |
Initializes the object. A symbol deletion logger can be passed so that additional cleanup can be done when a symbol is deleted from the table. |
Done |
Destructor |
Destructs the object. |
|
|
|
Max_Symbol_Length |
Longint |
Defines the maximum size of symbols (in bytes). Symbols with names exceeding this during add will be truncated. |
Case_Sensitive |
Boolean |
True if symbols are case sensitive. |
|
|
|
Add( Sym : string ; Addr, Flg, D_T, Siz : integer ; Dat : pointer ) |
Integer |
Adds a symbol to the table. All parameters are used to initialize the symbol record for the new symbol: Sym is the name of the symbol to add. Addr is used to initialize Address, D_T initialized Data_Type, and Siz initializes Size. The result is the operation status code. |
Clear |
n/a |
Deletes all the symbols in the table. |
ERT( X : integer ) |
String |
Returns text of passed error code. |
Find( Sym : string ; var Addr, Flg, D_T, Siz : integer ; var Dat : pointer ) |
integer |
Locates the specified symbol. The remaining parameters are ignored on call. On return, if the symbol is found, they contain information from the symbol entry in the table: Addr comes from Address, Flg from Flags, D_T from Data_Type, Siz from Size, and Dat from Data. The result is the operation status code. If Sym contains a wildcard, the first matching symbol is returned. |
Find_Next( var Addr, Flg, D_T, Siz : integer ; var Dat : pointer ) |
Integer |
Locates the next symbol (alphanumeric sort) after the last symbol located with Find. The parameters are ignored on call. On return, if a symbol is found, they contain information from the symbol entry in the table: Addr comes from Address, Flg from Flags, D_T from Data_Type, Siz from Size, and Dat from Data. The result is the operation status code. Status code 5 is returned when the end of the table is reached. The function locates all symbols - wildcards are not supported. |
Modify( Sym : string ; Addr, Flg, D_T, Siz : integer ; Dat : pointer ) |
integer |
Modifies the specified symbol in the table. The remaining parameters are new values for the symbol: Addr for Address, Flg for Flgas, D_T for Data_Type, Siz for Size, and Dat for Data. The result is the operation status code. If Sym contains a wildcard, the first matching symbol is the one modified. |
Pop_Level |
n/a |
Unnests the table one level. |
Push_Level |
n/a |
Nests the table one level. This is useful for starting a new sub-scope. |
Description:
This class defines a general symbol table. No duplicate symbol names are allowed in the table, but by using Push_Level, a sub-table can be created. Sub-tables can have symbols with the same name as the parent table(s). When a Find or Modify operation occurs, the inner-most table is searched first, followed by its parent, and so forth until all tables are searched or the symbol is found. Pop_Level effectively deletes the current innermost sub-table. Adds are always to the innermost sub-table.
Some calls allow wildcards in the symbol names: "?" indicates to match any one character and "*" means to match zero or more characters. For instance, "A*" indicates all symbols starting with "A".
Most operations return status codes. These codes can be converted to strings with the SERT function. The possible codes are:
Value |
Meaning |
0 |
The operation completed successfully. |
1 |
The symbol name was invalid (null or contained a wildcard on add). |
3 |
Symbol is already defined. |
4 |
Symbol was not found. |
5 |
No more symbols found in table. |
tText_Debugger
File: debugint.h, debugint.pas
Type: class (descendant of tDebug_Interface)
Methods:
Name |
Type |
Parameters |
Description |
Can_Change |
bool (boolean) |
n/a |
True if data can be modified. |
Child |
tDebug_Interface* (PDebug_Interface) |
Ordinal : int (longint) |
Returns child at specified index. |
Count |
int (longint) |
n/a |
Returns count of children. |
Get_Title |
char* (Pchar) |
n/a |
Returns title of this level. |
Set_Title |
void |
Value : char* (Pchar) |
Sets title of this level. |
Activate |
void |
n/a |
Activates the item. |
Kill |
void |
n/a |
Frees object. |
Modify |
char* (Pchar) |
Data : char* (Pchar); Size : int (longint) |
Modifies the data, setting it to Data (size bytes long). |
Description:
This descendant of tDebug_Interface is used for a line in the debug outline that is simple text.
TTri_State
File: typedefs.pas
Type: enumeration (Pascal)
Description:
Defines three states of tri-state logic: TS_False, TS_True, and TS_Dont_Care.
tUEC
File: uehdefs.pas
Type: record (Pascal); struct (C++)
Field |
Type |
Description |
Facility |
Longint (int) |
Facility code. |
Code |
Longint (int) |
Error code. |
Description:
Defines the Unified Error Code used by UEH-compliant code.
tVariant_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of Variants from 0 up to the maximum elements allowed within Max_Memory.
TWide_RGB
File: colors.pas
Type: structure
Field |
Type |
Description |
R |
word |
Red value |
G |
word |
Green value |
B |
word |
Blue value |
A |
word |
Alpha value |
Description:
This structure defines a 64-bit color definition consisting of 16-bit Red, 16-bit Blue, 16-bit Green, and 16-bit Alpha values.
tWideChar_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of WideChars from 0 up to the maximum elements allowed within Max_Memory.
tWideString_Array
File: typedefs.pas
Type: type (Delphi)
Description:
Defines an array of WideStrings from 0 up to the maximum elements allowed within Max_Memory.
TWildcard
File: files.pas
Type: class
Description:
This class is only used internally in the files unit.
tWord_Array
File: typedefs.pas
Type: type
Description:
Defines an array of Words from 0 up to the maximum elements allowed within Max_Memory.
tWordBool_Array
File: typedefs.pas
Type: type (Pascal)
Description:
Defines an array of WordBools from 0 up to the maximum elements allowed within Max_Memory.
TXY_List
File: lines.pas
Type: class (Delphi)
Methods:
Name |
Type |
Description |
Count |
Integer |
Number of points (X, Y pairs) defined. |
Clear |
n/a |
Deletes all points in list. |
Generate( A, B : TPoint ) |
N/a |
Creates a line between the two specified points. |
property X[ Index : integer ] |
Tpoint |
Returns the Indexth point. |
Description:
Defines an array of WordBools from 0 up to the maximum elements allowed within Max_Memory.
UEH_*
File: uec.h, uehdefs.pas
Type: defines (C), integer constants (Pascal)
Name |
Description |
UEH_Success |
Successful operation. |
UEH_Informational |
Informational message. |
UEH_Warning |
Warning, but operational successful. |
UEH_Error |
Error - operation failed. |
UEH_Fatal |
Serious error. |
Description:
These codes are used by the tError_Interface class.
Uninitialize_Find_Record
File: files.pas
Type: procedure
Parameters:
Name |
Type |
Description |
F |
Tfind_Record |
Record to uninitialize. |
Description:
This procedure releases all resources used by this find context. This should be called when a wildcard file lookup process is complete.
Unmap_Window
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Name |
Type |
Description |
Window_P |
Pwindow |
SMU window |
Description:
This function unmaps an SMU window from the screen. See Map_Window.
Unregister_Error_Interface
File: errmastr.pas
Type: longbool function
Parameters:
Parameter |
Type |
Description |
Facility |
longint |
Facility code for the error interface to unregister. |
Description:
Removes an error interface from the Error Interface List that was previous added with Register_Error_Interface.
Update_Journal
File: teu.c
Type: void function
Parameters: None
Description:
Updates the TEU journal file with any outstanding keystrokes to be logged.
Update_Screen
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters: None
Description:
Makes sure all mapped SMU windows are updated.
Update_Window
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters:
Parameter |
Type |
Description |
Window_P |
Pwindow |
SMU window to update. |
Description:
Posts any pending changes to the specified window, making them immediately visible (if mapped to the screen).
Uppercase
File: compatib.pas
Type: string function
Parameters:
Parameter |
Type |
Description |
X |
String |
String to convert to uppercase. |
Description:
Returns the passed string, with lowercase characters converted to upper case.
US
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 31 (Unit Separator).
Valid_Base
File: cvt.pas, cvt.c
Type: boolean function (Pascal), int function (C)
Parameters:
Name |
Type |
Description |
Value |
String |
Value to check. |
Base |
integer |
Base to check against (1 to 49, inclusive). |
Description:
Returns True if the passed string contains valid digits for the specified base. Otherwise, returns false.
Version
File: globals.pas
Type: string (Pascal)
Description:
Holds the version of the program. This should always be set at program-startup if any logging will be done.
Version
File: errmastr.pas
Type: longint function
Description:
Returns the version of the UEH interface (12 = Version 1.2).
VESA_0
File: tsrs.pas
Type: record
Fields:
Name |
Type |
Description |
Signature |
array[ 0..3 ] of char |
|
Major_Version |
byte |
Major version. |
Minor_Version |
byte |
Minor version. |
Manufacturer |
PChar |
Pointer to ASCIIZ string containing manufacturer's name. |
Flags |
longint |
|
Code_Numbers |
pointer |
|
Description:
VESA subfunction 0 buffer.
VESA_1
File: tsrs.pas
Type: record
Fields:
Name |
Type |
Description |
Mode |
word |
|
Flags |
array[ 0..1 ] of byte |
|
Granularity |
word |
|
Size |
word |
|
Segments |
array[ 0..1 ] of word |
|
Routine |
pointer |
|
Line_Bytes |
byte |
|
X_Resolution |
word |
|
Y_Resolution |
word |
|
Pixel_Width |
byte |
|
Pixel_Height |
byte |
|
Bitplanes |
byte |
|
Bits_Per_Pixel |
byte |
|
Blocks |
byte |
|
Model |
byte |
|
Block_Size |
Byte |
|
Description:
VESA subfunction 1 buffer.
VM_*
File: smubios.pas
Type: constants
Description:
These constants define the SMU screen video mode:
Mnuemonic |
Value |
Description |
VM_PC_Graphics |
5 |
Graphics mode on IBM PC. |
VM_Text |
7 |
Text mode. |
VT
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 11 (Vertical Tab).
VTS
File: asciidef.h, asciidef.pas
Type: define (C), String constant (Pascal)
Description:
ASCII code 138.
Wait_Idle
File: smubios.pas
Type: procedure (DOS only)
Parameters: None
Description:
Waits until the DEC Rainbow GDC is idle. When this routine returns, the GDC is guaranteed to be idle.
WC_Match
File: xlate.pas, xlate.c
Type: boolean function (Pascal), int function (C)
Parameters:
Name |
Type |
Description |
Wildcard |
String (char*) |
Wilcard specification to match against. |
Filename |
String (char*) |
Filename to match. |
Description:
Compares a filename and a wildcard specification and return trues if a match. Wildcard characters are:
Character |
Meaning |
? |
Match any one character. |
* |
Match zero or more characters. |
… |
Only valid as "\…" or "\…\". Matches any number of subdirectory levels. |
WC_Xlate
File: xlate.pas, xlate.c
Type: string function (Pascal) , char* function (C)
Parameters:
Name |
Type |
Description |
Reference |
String |
Input specification, with or without wildcards. |
Filename |
String |
Filename, matching Reference specification, that is to be translated into a filename matching the output specification. Must not contain wildcards. |
Wildcard |
String |
Output specification, with or without wildcards. |
Description:
Translate a wildcard specification and an input file name to an output spec. This function is used when copying one wildcard specification to another. For each filename matching the input (Reference) specification, this function is called and returns the passed filename, translated via the output specification (Wildcard). For instance if Reference is "*.IN" and Filename is "A.IN", and Wildcard is "*.OUT", then the resulting string will be "A.OUT". This function uses the same wildcard rules as WC_Match.
Wind
File: weather.pas
Type: real function (Pascal)
Parameters:
Name |
Type |
Description |
Speed |
real |
Wind speed (in mph). |
Temperature |
Real |
Ambient air temperature (in degrees Fahrenheit). |
Description:
Returns the effective temperature due to wind chill for the passed values.
Wind
File: wind.c
Type: double function
Parameters:
Name |
Type |
Description |
Speed |
double |
Wind speed (in mph). |
Temperature |
double |
Ambient air temperature (in degrees Fahrenheit). |
Description:
Returns the effective temperature due to wind chill for the passed values.
Window
File: smu.h
Type: struct
Fields:
Name |
Type |
Description |
Level |
Int |
Level of window. |
Attribute |
short int |
Current attributes. |
Rows |
short int |
Row count. |
Columns |
short int |
Column count. |
Map_Row |
short int |
Row on screen where window is mapped (upper left corner). |
Map_Column |
short int |
Column on screen where window is mapped (upper left corner). |
Map_Rows |
short int |
Number of rows mapped to screen. |
Map_Columns |
short int |
Number of columns mapped to screen. |
View_Row |
short int |
Top row of window available in mapped view. |
View_Column |
short int |
Left column of window available in mapped view. |
Position_Row |
short int |
Current character row. |
Position_Column |
short int |
Current character column. |
Low_Update |
int |
Low offset needing update. |
High_Update |
int |
High offset needing update. |
Size |
int |
Window size, in bytes (columns * rows). |
Flags |
int |
Flags for this window: & 1 = No scroll (vertical wrap) (all other values reserved) |
Data_Pointer |
char* |
Pointer to screen data. |
Attribute_Pointer |
char* |
Pointer to attribute data. |
Next_Window |
Window* |
Pointer to next window in list. |
Id |
int |
Window ID. |
Description:
This structure defines an SMU window.
Window
File: smu.pas
Type: record
Fields:
Name |
Type |
Description |
Level |
Integer |
Level of window. |
Attribute |
byte |
Current attributes. |
Border |
Byte |
Size of border. |
Rows |
integer |
Row count. |
Columns |
integer |
Column count. |
Map_Row |
integer |
Row on screen where window is mapped (upper left corner). |
Map_Column |
integer |
Column on screen where window is mapped (upper left corner). |
Map_Rows |
integer |
Number of rows mapped to screen. |
Map_Columns |
integer |
Number of columns mapped to screen. |
View_Row |
integer |
Top row of window available in mapped view. |
View_Column |
integer |
Left column of window available in mapped view. |
Position_Row |
integer |
Current character row. |
Position_Column |
integer |
Current character column. |
Low_Update |
integer |
Low offset needing update. |
High_Update |
integer |
High offset needing update. |
Size |
integer |
Window size, in bytes (columns * rows). |
Flags |
integer |
Flags for this window: And 1 = No scroll (vertical wrap) (all other values reserved) |
Data_Pointer |
Window_Def_Pointer |
Pointer to screen data. |
Attribute_Pointer |
Window_Def_Pointer |
Pointer to attribute data. |
Text_Height |
Integer |
Height of default font characters. |
Text_Width |
Integer |
Width of default font characters. |
Next_Window |
PWindow |
Pointer to next window in list. |
Id |
integer |
Window ID. |
Description:
This structure defines an SMU window.
Window_Async_Input_Line
File: smu.pas
Type: boolean function
Fields:
Name |
Type |
Description |
Window_P |
Pwindow |
Window to echo input to. |
Flags |
Integer |
Processing options: And 128 = interpret CR as data instead of delimiter |
Key |
String |
Null on first call, the last key input by the user on subsequent calls. |
Description:
Processes a keystroke (if Key is null, it retrieves one keystroke before returning). If the keystroke ends the input (ie is a delimiter), the function returns True. Otherwise it returns false. This function processes special keys as follows:
Key |
Processing |
LEFT |
Move cursor left one character. |
RIGHT |
Move cursor right one character |
UP |
Move to previous line of history. |
DOWN |
Move to next line of history. |
F4 |
Toggle print mode |
F6 |
Print screen |
ENTER or Control+M |
End line of input. |
Control+A |
Toggle insert/overwrite. |
Control+E |
Move cursor to end of line. |
Control+J |
End line of input. |
Control+L |
End line of input. |
Control+R |
Refresh window. |
Control+U |
Erase input line. |
Control+W |
Refresh screen. |
Control+Y |
Clear input buffer and line and end input. |
Control+Z |
End line of input. |
ESCAPE |
End line of input |
DELETE or BACKSPACE |
Delete character to left of cursor. |
Window_Def
File: smu.pas
Type: record
Fields:
Name |
Type |
Description |
Bytes |
array[ 0..32767 ] of Byte |
Access to windows contents as an array of bytes. |
Chars |
array[ 0..32767 ] of char |
Access to windows contents as an array of chars. |
Description:
Takes an entire line of input from the keyboard, echoing it to the specified window and storing it in Kb_Buffer.
Window_Def_Pointer
File: smu.pas
Type: type (pointer)
Description:
Pointer to Window_Def record.
Window_Input_Line
File: smu.c, smu.pas
Type: void function
Parameters:
Name |
Type |
Description |
Window_P |
Pwindow |
SMU window. |
Flags |
Integer |
Input options: & 128 = Ignore CR. |
Description:
Takes an entire line of input from the keyboard, echoing it to the specified window and storing it in Kb_Buffer. See Window_Async_Input_Line for details on special character processing.
Window_Mapped
File: smu.c. smu.pas
Type: int function (C), boolean function (Pascal)
Parameters:
Name |
Type |
Description |
Window_Pointer |
Pwindow |
SMU window. |
Description:
Returns true if the passed window is mapped to the screen.
Window_Output
File: smu.c
Type: void function
Parameters:
Name |
Type |
Description |
Buffer |
char* |
Data to output. |
Description:
Outputs the specified text to the current window position.
Window_Read
File: smu.c, smu.pas
Type: void function (C), procedure (Pascal)
Parameters: None
Description:
Takes an entire line of input from the keyboard, echoing it to the default window and storing it in Kb_Buffer.
Window_Read_Input
File: smu.c
Type: void function (C), procedure (Pascal)
Parameters:
Name |
Type |
Description |
Flags |
Integer |
Input options: & 128 = Ignore CR. |
Description:
Takes an entire line of input from the keyboard, echoing it to the default window and storing it in Kb_Buffer.
Window_Record
File: smu.h, smu.pas
Type: struct (C), record (Pascal)
Fields:
Name |
Type |
Description |
Pointer |
Pwindow |
Pointer to window structure. |
Id |
Integer |
Window ID for window at Pointer. |
Description:
Associates an ID with an SMU window structure.
Window_To_Screen_Column
File: smu.pas
Type: integer function
Fields:
Name |
Type |
Description |
Window |
Pwindow |
SMU Window. |
Column |
Integer |
Window column. |
Description:
Returns the Screen column corresponding to the passed window column for the passed window.
Window_To_Screen_Row
File: smu.pas
Type: integer function
Fields:
Name |
Type |
Description |
Window |
Pwindow |
SMU Window. |
Row |
Integer |
Window row. |
Description:
Returns the Screen row corresponding to the passed window row for the passed window.
WorkBLen
File: io.asm
Type: DB
Description:
Length of data in WorkBuff, in bytes.
WorkBuff
File: io.asm
Type: DB 256 DUP (0)
Description:
Work buffer used by assembly routines.
Write_Screen
File: smubios.pas
Type: procedure
Parameters:
Name |
Type |
Description |
ID |
integer |
SMU window ID of window to write to. |
L |
Integer |
Starting line (row) to write to. |
C |
Integer |
Starting column to write to. |
Text_Height |
Integer |
Maximum height of text. |
Text_Width |
Integer |
Maximum width of text. |
Border |
integer |
Size of border around text. This is pixels in graphics mode and character cells in text mode. |
Driver |
Pointer |
Screen I/O driver to use to write text. |
Screen_String |
String |
Text to write. |
Attribute_String |
String |
Attributes for Screen_String. Each byte in this string corresponds to the same offset in Screen_String. |
Description:
Writes text to the screen.
Write_Text
File: smubios.pas
Type: procedure (DOS only)
Parameters:
Name |
Type |
Description |
X |
byte |
Screen Row to write to. |
Y |
Byte |
Screen Column to write to. |
C |
Char |
Character to write. |
Description:
Writes a single character to specified location on screen, using current character attributes.
XBit_Values
File: standard.pas
Type: array[ 0..63 ] of int64 (Delphi)
Description:
This array contains powers of 2 from 0 to 63. For instance XBit_Values[ 10 ] is 1024. See also Bit_Values.
XRegisters
File: tsrs.pas
Type: Record
Fields:
Name |
Type |
Description |
Bp |
Word |
|
Es |
Word |
|
Ds |
Word |
|
Di |
Word |
|
Si |
Word |
|
Dx |
Word |
|
Cx |
Word |
|
Bx |
Word |
|
Ax |
Word |
|
Ss |
Word |
|
Sp |
Word |
|
Cs |
Word |
|
Ip |
Word |
|
Flags |
Word |
|
Fill1a |
Byte |
|
Fill1b |
Byte |
|
Fill2a |
Byte |
|
Fill2b |
Byte |
|
Fill3a |
Byte |
|
Fill3b |
Byte |
|
Fill4a |
Byte |
|
Fill4b |
Byte |
|
Fill5a |
Byte |
|
Fill5b |
Byte |
|
Dl |
Byte |
|
Dh |
Byte |
|
Cl |
Byte |
|
Ch |
Byte |
|
Bl |
Byte |
|
Bh |
Byte |
|
Al |
Byte |
|
Ah |
Byte |
|
Description:
Extended Registers type.
XTime
File: dates.pas, standard.c
Type: string function (Pascal), char* function (C)
Parameters: None
Description:
Returns the current time in "HH:MM:SS.HH xM" format. See also Time.
XVal
File: num1s.pas, nums.c
Type: extended function (Pascal), long double function (C)
Parameters:
Parameter |
Type |
Description |
S |
String |
Value to convert. |
F |
Var integer |
Note: This parameter does not exist in the C version. Ignored when passed. On return, 0 for no errors. Otherwise it is the position of the first invalid character in the passed number. |
Description:
Return extended value converted from passed string.
_ACK
File: asciidef.asm
Type: equate
Description:
ASCII code 6 (Acknowledge)
_APC
File: asciidef.asm
Type: equate
Description:
ASCII code 159
_BEL
File: asciidef.asm
Type: equate
Description:
ASCII code 7 (Bell)
_BS
File: asciidef.asm
Type: equate
Description:
ASCII code 8 (Backspace)
_CAN
File: asciidef.asm
Type: equate
Description:
ASCII code 24 (Cancel)
_CCH
File: asciidef.asm
Type: equate
Description:
ASCII code 148
_CR
File: asciidef.asm
Type: equate
Description:
ASCII code 13 (Carriage return)
_CSI
File: asciidef.asm
Type: equate
Description:
ASCII code 155
_DC1
File: asciidef.asm
Type: equate
Description:
ASCII code 17 (Direct Control 1)
_DC2
File: asciidef.asm
Type: equate
Description:
ASCII code 18 (Direct Control 2)
_DC3
File: asciidef.asm
Type: equate
Description:
ASCII code 19 (Direct Control 3)
_DC4
File: asciidef.asm
Type: equate
Description:
ASCII code 20 (Direct Control 4)
_DCS
File: asciidef.asm
Type: equate
Description:
ASCII code 144
_DEL
File: asciidef.asm
Type: equate
Description:
ASCII code 127 (Delete)
_DLE
File: asciidef.asm
Type: equate
Description:
ASCII code 16 (Data Link Escape)
_EBS
File: asciidef.asm
Type: equate
Description:
ASCII code 254 (Extended backspace)
_EM
File: asciidef.asm
Type: equate
Description:
ASCII code 25 (End of Medium)
_ENQ
File: asciidef.asm
Type: equate
Description:
ASCII code 5 (Enquiry)
_EOT
File: asciidef.asm
Type: equate
Description:
ASCII code 4 (End Of Transmission)
_EPA
File: asciidef.asm
Type: equate
Description:
ASCII code 151
_ESA
File: asciidef.asm
Type: equate
Description:
ASCII code 135
_ESC
File: asciidef.asm
Type: equate
Description:
ASCII code 27 (Escape)
_ETB
File: asciidef.asm
Type: equate
Description:
ASCII code 23 (End Tranmission Block)
_ETX
File: asciidef.asm
Type: equate
Description:
ASCII code 3 (End Text)
_FF
File: asciidef.asm
Type: equate
Description:
ASCII code 12 (Form Feed)
_FS
File: asciidef.asm
Type: equate
Description:
ASCII code 28 (Form separator)
_GS
File: asciidef.asm
Type: equate
Description:
ASCII code 29 (Group separator)
_HT
File: asciidef.asm
Type: equate
Description:
ASCII code 9 (Horizontal Tab)
_HTJ
File: asciidef.asm
Type: equate
Description:
ASCII code 137
_HTS
File: asciidef.asm
Type: equate
Description:
ASCII code 136
_IND
File: asciidef.asm
Type: equate
Description:
ASCII code 132
_LF
File: asciidef.asm
Type: equate
Description:
ASCII code 10 (Line Feed)
_MW
File: asciidef.asm
Type: equate
Description:
ASCII code 149
_NAK
File: asciidef.asm
Type: equate
Description:
ASCII code 21 (Negative Acknowledge)
_NBSP
File: asciidef.asm
Type: equate
Description:
ASCII code 160
_NEL
File: asciidef.asm
Description:
ASCII code 133
_NUL
File: asciidef.asm
Type: equate
Description:
ASCII code 0 (Null)
_OSC
File: asciidef.asm
Description:
ASCII code 157
_PLD
File: asciidef.asm
Description:
ASCII code 139
_PLU
File: asciidef.asm
Description:
ASCII code 140
_PM
File: asciidef.asm
Description:
ASCII code 158
_PU1
File: asciidef.asm
Description:
ASCII code 145
_PU2
File: asciidef.asm
Description:
ASCII code 146
_RI
File: asciidef.asm
Description:
ASCII code 141
_RS
File: asciidef.asm
Type: equate
Description:
ASCII code 30 (Record separator)
_SI
File: asciidef.asm
Type: equate
Description:
ASCII code 15 (Shift In)
_SO
File: asciidef.asm
Type: equate
Description:
ASCII code 14 (Shift Out)
_SOH
File: asciidef.asm
Type: equate
Description:
ASCII code 1 (Start Of Heading)
_SP
File: asciidef.asm
Type: equate
Description:
ASCII code 32 (Space)
_SPA
File: asciidef.asm
Description:
ASCII code 150
_Space
File: asciidef.asm
Description:
ASCII code 32 ;
_SS2
File: asciidef.asm
Description:
ASCII code 142
_SS3
File: asciidef.asm
Description:
ASCII code 143
_SSS
File: asciidef.asm
Description:
ASCII code 134
_ST
File: asciidef.asm
Description:
ASCII code 156
_STS
File: asciidef.asm
Description:
ASCII code 147
_STX
File: asciidef.asm
Type: equate
Description:
ASCII code 2 (Start Text)
_SUB
File: asciidef.asm
Type: equate
Description:
ASCII code 26 (Substitute)
_SYN
File: asciidef.asm
Type: equate
Description:
ASCII code 22 (Synchronous idle)
_US
File: asciidef.asm
Type: equate
Description
ASCII code 31 (Unit separator)
_VT
File: asciidef.asm
Type: equate
Description:
ASCII code 11 (Vertical Tab)
_VTS
File: asciidef.asm
Type: equate
Description:
ASCII code 138