APPX Runtime Subroutine API
This API can be used by an APPX designer to interact with the APPX Runtime Application (---) to gain access to extra functionality.
Overview
Release 5.1.0 of the APPX Utility includes a new standardized designer API which can be used to gain access to extended functionality from within an APPX application. This API provides APPX Designers with a robust set of subroutines which can be called to do a variety of tasks. This API replaces the older subroutines that have been informally used, and all designers are encouraged to begin using the new subroutines.
General Information
All of these new subroutines are defined in the (---) application and begin with a period (.). They all use a standard call interface and use the same framework for returning resuts and reporting errors. They are grouped by name prefix so that related subroutines are grouped together by function. Data is passed into and returned from these subroutines by use of the PASS statement. Failure information is returned by use of a work field with the same name as the subroutine. This failure code field is tokenized so you can scan to see the failure reasons that can be returned.
If the subroutine accepts parameters (ie, READ, WRITE, APPEND to --- .STREAM OPEN), the parameters are case insensitive.
If the subroutine has required paremeters and you do not PASS the correct number of paremeters, the subroutine will issue a CANCEL identifying which parameter was missing.
General Subroutines
Utility Routines
Checks the security code for the specified user.
Clears any unfilled PASS requests.
For a given Process Type/Name, returns the Em name.
Copies the engine Hook records into a temporary file for modification.
Exits or logout a user after a set timeout period.
Loads --- STACK with the current process stack.
Not Implemented
Modifies the standard bahavior of a scrolling input process to allow the user to place the cursor on a different record and press ENTER to select it.
Writes the current record to the Query pointer file.
Activates the hooks in the temporary file.
Sets the keyboard timeout value.
Pauses for the specified number of seconds.
Pauses for the specified number of seconds with a countdown timer.
Update process documentation via ILF
Data Manipulation Subroutines
Conversion Routines
Convert a hex pair of alpha characters to a decimal number.
Convert a decimal number to a hex pair of alpha characters.
Split a number into it's whole and fractional parts.
Text Routines
Fills a field with a single charcter repeated the given number of times.
Removes characters from a given text or alpha field.
Find the position of the given text in a given text or alpha field.
Find and replace the given text in a given text or alpha field.
Determine the length of text within a given text or alpha field.
Inserts text into a given text or alpha field.
Convert lower case text to upper case text within a given text or alpha field.
Convert upper case text to lower case text within a given text or alpha field.
System Information Subroutines
Server Environment Routines
Returns the path to the location of Appx data files.
Returns the value of a command line parameter.
Populates PDF fields with configuration information.
Returns the value of an environment variable.
Return the type of operating system Appx is running on.
Returns the name and type of the parent process.
Returns the pathname of the requested APPX data file.
Returns the directory seperator character of the host operating system.
Returns the size of the Appx screen in rows and columns.
Sets the value of an environment variable (not yet implemented).
Displays the APPX license info for the current application.
File System Utilities Subroutines
File Manipulation Routines
These subroutines provide you with a way to manipulate files on the file system without having to check the O/S type (ie, using 'cp' vs 'copy', or different kernal calls).
Copies a file from one location to another, creating any required directories.
Creates an archive of the specified files, in either TAR or TGZ format.
Deletes the given file from the filesystem.
Tests for the existance of the given file in the filesystem.
Extracts all the files from a previously created archive.
Creates the given directory and parent directories in the filesystem.
Moves a file or directory from one location to another, creating any required directories
Splits the filename from the file extension and returns both.
Splits the filename from the path and returns both.
Stream File Routines
The stream routines provide a way to work directly with text files, or to get the standard output of a command (via pipes).
Closes a file stream and frees up the stream resources for that file.
Closes all file streams and frees up the stream resources for those files.
Opens a stream to the given file creating the file and path as needed.
Read data from the given stream.
Write data to the given stream.
--
PeteBrower - 2011-08-12