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.

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 os the subroutine. This failure code field is tokenized so ou can scan to see the failure reasons that can be returned.

General Subroutines

Utility Routines

.UTIL MOD SCROLL BEHAV

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.

Data Manipulation Subroutines

Conversion Routines

.CONVERT HEX PR TO NUM

Convert a hex pair of alpha characters to a decimal number.

.CONVERT NUM TO HEX PR

Convert a decimal number to a hex pair of alpha characters.

.CONVERT SPLIT NUMBER

Split a number into it's whole and fractional parts.

Text Routines

.TEXT CREATE PAD

Fills a field with a single charcter repeated the given number of times.

.TEXT CUT AT POS

Removes characters from a given text or alpha field.

.TEXT FIND

Find the position of the given text in a given text or alpha field.

.TEXT FIND AND REPLACE

Find and replace the given text in a given text or alpha field.

.TEXT GET LENGTH

Determine the length of text within a given text or alpha field.

.TEXT INSERT AT POS

Inserts text into a given text or alpha field.

.TEXT LOWER TO UPPER

Convert lower case text to upper case text within a given text or alpha field.

.TEXT UPPER TO LOWER

Convert upper case text to lower case text within a given text or alpha field.

System Information Subroutines

Server Environment Routines

.ENV GET OS TYPE

Return the type of operating system Appx is running on.

.ENV GET PATH SEPERATR

Return the directory seperator character of the host operating system.

File System Utilities Subroutines

File Manipulation Routines

.FILE DELETE

Deletes the given file from the filesystem.

.FILE EXISTS

Tests for the existance of the given file in the filesystem.

.FILE MAKE DIR

Creates the given directory and parent directories in the filesystem.

.FILE SPLIT FILENAME

Splits the filename from the file extension and returns both.

.FILE SPLIT PATHNAME

Splits the filename from the path and returns both.

Stream File Routines

.STREAM CLOSE

Closes a file stream and frees up the stream resources for that file.

.STREAM CLOSE ALL

Closes all file streams and frees up the stream resources for those files.

.STREAM OPEN

Opens a stream to the given file creating the file and path as needed.

.STREAM READ

Read data from the given stream.

.STREAM WRITE

Write data to the given stream.

-- PeteBrower - 2011-08-12