Appendix A - Grouped Functions

This chapter groups the ScriptEase internal library functions by category for cross-reference. It applies to all versions of ScriptEase, but some functions are only applicable to certain ScriptEase versions; for example, the Window() function will not apply to ScriptEase for DOS.

Character Classification

isalnum	Test for alphanumeric character.
isalpha	Test for alphabetic character.
isascii	Test for ASCII coded character.
iscntrl	Test for any control character.
isdigit	Test for any decimal-digit character.
isgraph	Test for any printing character except for space.
islower	Test for lower-case alphabetic letter.
isprint	Test for any printing character including space.
ispunct	Test for punctuation character.
isspace	Test for white-space character.
isupper	Test for upper-case alphabetic character.
isxdigit	Test for hexadecimal-digit character.
toascii	Translate character to ASCII (7-bit) format.
tolower	Translate character to lower-case if it is upper-case.
toupper	Translate character to upper-case if it is lower-case.

Console I/O

kbhit	Check if a keyboard keystroke is available.
getch	Get a character from the keyboard; without echo.
getchar	Get a character from standard input (keyboard).
getche	Get a character from the keyboard; with echo.
gets	Read a string from standard input (keyboard).
perror	Prints a message describing error in errno.
printf	Formatted output to the standard output stream (screen).
putchar	Write a character to the standard output stream (console).
puts	Write a string to the standard output stream (console).
scanf	Formatted input from the standard input stream (keyboard).
ScreenClear	Clear screen.
ScreenCursor	Get or set cursor position in the visible screen.
ScreenSize	Get the height and width of the screen.
vprintf	Formatted output to the standard output stream (screen) using arg_list.
vscanf	Formatted input from standard input stream (keyboard) using arg_list.

Data

_BigEndianMode	Global variable to specify Cmm-data to memory-data conversion
BLObGet	Read data from specified location of a Binary Large Object (BLOb).
BLObPut	Write data into specified location of a Binary Large Object (BLOb).
BLObSize	Determine size of a Binary Large Object (BLOb).
byte	Return numerical value as represented by a byte.
DataDimension	Determine dimension of variable data.
DataType	Determine data type of a variable.
defined	Test if variable has been defined.
float	Return numerical value as represented by a floating-point number.
GetArraySpan	Determine size of an array.
GetStructure Members	Get a name list of all the members of a structure
integer	Return numerical value as represented by an integer.
SetArraySpan	Set size of an array.
StructureMember	Access structure member by name
undefine	Make a variable undefine.

Diagnostic/Error

abort	Terminate program; probably due to error.
assert	Test a condition and abort if it is FALSE.
clearerr	Clear end-of-file and error status for a file.
errno	Value of error condition
ferror	Test for error on a file stream.
perror	Prints an message describing error in errno.
strerror	Get a string describing an error number.

DOS (& Windows 3.x)

Address	Convert segment:offset pointer into memory address.
asm	Execute imbedded assembled code.
inport	Read byte from a hardware port.
inportw	Read word from a hardware port.
interrupt	Execute an 8086 interrupt.
offset	Break far pointer into segment:offset components.
outport	Write byte to a hardware port.
outportw	Write word to a hardware port.
segment	Break far pointer into segment:offset components.

Execution Control

abort	Terminate program; probably due to error.
assert	Test a condition and abort if it is FALSE.
atexit	Register function to be called at program exit.
exit	Normal program termination.
function	Call a function by name.
Interpret	Interpret Cmm code or source file.
spawn	Run an external executable.
Suspend	Suspend program execution for a while.
system	Pass a command to the command processor.

File (and stream) I/O

clearerr	Clear end-of-file and error status for a file.
fclose	Close an open file.
feof	Test if at end of file stream.
ferror	Test for error on a file stream.
fflush	Flush stream for open file(s).
fgetc	Get a character from file stream.
fgetpos	Get current position of a file stream.
fgets	Get a string from an input stream.
fopen	Open a file.
fprintf	Formatted output to a file stream.
fputc	Write a character to a file stream.
fputs	Write a string to a file stream.
fscanf	Formatted input from a file stream.
fread	Read data from a file.
freopen	Assign a new file specification to a file handle.
fseek	Set the file position for an opened file stream.
fsetpos	Set position of a file stream.
ftell	Get the current value of the file position.
fwrite	Write data to a file.
getc	Get a character from file stream.
getchar	Get a character from standard input (keyboard).
gets	Read a string from standard input (keyboard).
printf	Formatted output to the standard output stream (screen).
putc	Write a character to a file stream.
putchar	Write a character to the standard output stream (console).
puts	Write a string to the standard output stream (console).
remove	Delete a file.
rename	Rename a file.
rewind	Reset file position to beginning of file.
scanf	Formatted input from the standard input stream (keyboard).
tmpfile	Create a temporary binary file.
tmpnam	Get a temporary file name.
ungetc	Push character back to input stream.
vfprintf	Formatted output to a file stream using arg_list.
vfscanf	Formatted input from a file stream using arg_list.
vprintf	Formatted output to the standard output stream (screen) using arg_list.
vscanf	Formatted input from the standard input stream (keyboard) using arg_list.

File Directory

Directory	Search directory listing for a file specification.
FullPath	Convert partial path specification to full path name.
SplitFileName	Determine directory, name, and extension parts of a file specification.

Math

abs	Return the absolute value of an integer (non-negative).
asin	Calculate the arc sine.
acos	Calculate the arc cosine.
atan	Calculate the arc tangent.
atan2	Calculate the arc tangent of a fraction.
atof	Convert ascii string to a floating-point number
atoi	Convert ascii string to an integer.
atol	Convert ascii string to an integer.
ceil	Ceiling; round up.
cos	Calculate the cosine.
cosh	Calculate the hyperbolic cosine.
div	Integer division, returning quotient and remainder.
exp	Compute the exponential function.
fabs	Absolute value.
fmod	Modulus; calculate remainder.
floor	Round down.
frexp	Break into a mantissa and an exponential power of 2.
labs	Return the absolute value of an integer (non-negative).
ldexp	Calculate mantissa * 2 ^ exp; inverse of frexp().
ldiv	Integer division, returning quotient and remainder.
log	Calculate the natural logarithm.
log10	Calculate the base-ten logarithm.
max	Return the largest of one or more values.
min	Return the minimum of one or more values.
modf	Split a value into integer and fractional parts.
pow	Calculates x to the power of y.
rand	Generate a random number.
sin	Calculate the sine.
sinh	Calculate the hyperbolic sine.
sqrt	Calculate the square root.
srand	Initialize random number generator
tan	Calculate the tangent.
tanh	Calculate the hyperbolic tangent.
strtod	Convert a string to a floating-point value.
strtol	Convert a string to an integer value.

Memory (computer memory)

peek	Read data from memory location.
pointer	Get address of variable array or variable datum.
poke	Write data to memory location.

Miscellaneous

bsearch	Binary search for member of a sorted array.
function	Call a function by name.
getenv	Get an environment string.
putenv	Set an environment string.
qsort	Sort an array using specified comparison function.
rand	Generate a random number.
ShellFilter Character	Add character filter function to ScriptEase shell
ShellFilter Command	Add command filter function to ScriptEase shell
srand	Initialize random number generator
suspend	Suspend program execution for a while.

OS/2 2.x

asm	Execute imbedded assembled code.
DynamicLink	Call a function in a Dynamic Link Library (DLL).
ESet	Write new environment variables settings into a file.
Info	Retrieve information about this ScriptEase process.
inport	Read byte from a hardware port.
inportw	Read word from a hardware port.
outport	Write byte to a hardware port.
outportw	Write word to a hardware port.
PMDynamicLink	Call a function in a Dynamic Link Library (DLL).
PMInfo	Retrieve information about the ScriptEase 2PM process.
PMpeek	Read data from memory location via ScriptEase 2PM.exe
PMpoke	Write data to memory location via ScriptEase 2PM.exe.
ProcessList	Get list of all running processes.

Strings (and byte arrays)

atof	Convert ascii string to a floating-point number
atoi	Convert ascii string to an integer.
atol	Convert ascii string to an integer.
memchr	Search a byte array, or blob, for a character.
memcmp	Compare two byte arrays.
memcpy	Copy bytes from one array to another.
memicmp	Case-insensitive compare two byte arrays.
memmove	Copy bytes from one array to another.
memset	Set values in a byte array to specific character.
rsprintf	Return formatted string.
sprintf	Formatted output to a string.
sscanf	Formatted input from a string.
strcat	Append (concatenate) one string onto the end of another.
strchr	Search a string for a character.
strcmp	Compare two strings.
strcmpi	Case-insensitive compare two strings.
strcpy	Copy from one string into another.
strcspn	Search string for first character from a set of characters.
strerror	Get a string describing an error number.
strftime	Formatted write of date and/or time into a string.
stricmp	Case-insensitive compare two strings.
strlen	Length of a string.
strlwr	Converts string to lower-case characters.
strncat	Concatenate up to len bytes of one string to the end of another.
strncmp	Compare part of two strings.
strncmpi	Case-insensitive compare part of two strings.
strncpy	Copy given number of bytes from one string into another.
strnicmp	Case-insensitive compare part of two strings.
strpbrk	Search string for first character from a set of characters.
strrchr	Search a string for the last occurrence of a character.
strspn	Search string for first character not in a set of characters.
strstr	Search string for a substring.
strstri	Case insensitive version on strstr.
strtod	Convert a string to a floating-point value.
strtok	Search a string for delimited tokens.
strtol	Convert a string to an integer value.
strupr	Converts string to upper-case characters.
vsprintf	Formatted output to a string using arg_list.
vsscanf	Formatted input from a string.

Time and Date

asctime	Convert data and time to an ASCII string.
clock	Get processor time.
ctime	Convert date-time to an ascii string.
difftime	Compute difference between two times.
gmtime	Convert data and time to Greeenwich mean time (GMT).
localtime	Convert data and time to broken-down structure.
mktime	Convert time structure into calendar time.
time	Get current time.
strftime	Formatted write of date and/or time into a string.

UNIX

dlcall	Call a routine in a shared object under Linux, Sun OS, Solaris, FreeBSD, or AIX (all Unix versions currently supported).
fork	Create a duplicate of the current process.
getcwd	Get the current working directory.
setsid	Create a new session with no terminal.
setuid	Change a process' user ID.
waitpid	Wait for a child to exit and then clean it up.

Variable Argument Lists

rvsprintf	Return formatted string using arg_list.
va_arg	Retrieve variable from variable argument list.
va_end	Terminate variable argument list.
va_start	Initialize variable argument list.
vfprintf	Formatted output to a file stream using arg_list.
vfscanf	Formatted input from a file stream using arg_list.
vprintf	Formatted output to the standard output stream (screen) using arg_list.
vscanf	Formatted input from the standard input stream using arg_list.
vsprintf	Formatted output to a string using arg_list.
vsscanf	Formatted input from a string.

Windows 3.x

BreakWindow	Destroy a Window or windows created with MakeWindow().
BaseWindow Function	Call base procedure of a subclassed window
DoWindows	Process windows messages.
DynamicLink	Call a function in a Dynamic Link Library (DLL).
Instance	Get ScriptEase instance for this session.
MakeWindow	Define and create a window.
MessageFilter	Restrict message handled by ScriptEase window functions
MultiTask	Turn Windows multitasking on or off.
ScreenHandle	Get Windows' handle for the ScriptEase text screen.
ScreenSize	Get or set the height and width of the screen.
SubclassWindow	Hook into Window function for any function
WindowList	Retrieve list of window handles.

Windows NT/95/98 (Console and GUI)

BaseWindow Function	Call base procedure of a subclassed window
BreakWindow	Destroy a Window or windows created with MakeWindow().
DoWindows	Process windows messages.
DynamicLink	Call a function in a Dynamic Link Library (DLL).
ESet	Write new environment variables settings into a file.
Instance	Get ScriptEase instance for this session.
MakeWindow	Define and create a window.
MessageFilter	Restrict message handled by ScriptEase window functions
ScreenHandle	Get Windows' handle for the ScriptEase text screen.
ScreenSize	Get or set the height and width of the screen.
SubclassWindow	Hook into Window function for any function
WindowList	Retrieve list of window handles.