Difference: APPXRuntimeSubroutineAPI (1 vs. 59)

Revision 592021-05-07 - MisaghKarimi

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 346 to 346
 

.FILE RESTRUCT

Restructures the specified file.

Changed:
<
<

.FILE SPLIT FILENAME

>
>

.FILE SPLIT FILENAME

  Splits the filename from the file extension and returns both.
Changed:
<
<

.FILE SPLIT PATHNAME

>
>

.FILE SPLIT PATHNAME

  Splits the filename from the path and returns both.

Stream File Routines

Revision 582020-05-22 - MisaghKarimi

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 282 to 282
  Returns a flag to indicate if the user is running the Desktop Client.
Changed:
<
<

.CLIENT CHECK VERSION

>
>

.CLIENT CHECK VERSION

  Returns the version of the Desktop Client.

Revision 572020-05-19 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Revision 562020-05-12 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 118 to 118
  Update process documentation via ILF

Web Processing Routines

Changed:
<
<

.IMPORT CGI DATA

>
>

.IMPORT CGI DATA

  Populates Appx Variables from STDIN.

WIDGET Routines

.WIDGET APPLY THEME

Applies a GUI Theme to the current image.

Changed:
<
<

.WIDGET CNV CLR TO RGB

>
>

.WIDGET CNV CLR TO RGB

  Converts an alpha/hex color code to decimal.
Changed:
<
<

.WIDGET CNV RGB TO CLR

>
>

.WIDGET CNV RGB TO CLR

  Converts a decimal color code to alpha/hex.

.WIDGET DEL BY NAME

Line: 197 to 197
  Splits a number into its whole and fractional parts.
Changed:
<
<

.CONVERT TEXT TO HTML

>
>

.CONVERT TEXT TO HTML

  Converts a text field to HTML encoding
Line: 250 to 250
  Returns the value of an environment variable.
Changed:
<
<

.ENV GET OS TYPE

>
>

.ENV GET OS TYPE

  Return the type of operating system Appx is running on.
Changed:
<
<

.ENV GET PARENT PROC

>
>

.ENV GET PARENT PROC

  Returns the name and type of the parent process.

.ENV GET PATH NAME

Returns the pathname of the requested APPX data file.

Changed:
<
<

.ENV GET PATH SEP

>
>

.ENV GET PATH SEP

  Returns the directory separator character of the host operating system.
Line: 278 to 278
 Displays the APPX license info for the current application.

Client Routines

Changed:
<
<

.CLIENT CHECK FOR GUI

>
>

.CLIENT CHECK FOR GUI

  Returns a flag to indicate if the user is running the Desktop Client.
Line: 298 to 298
  Returns the value of a client constant
Changed:
<
<

.CLIENT LOAD URL

>
>

.CLIENT LOAD URL

  Loads a URL, document, runs a command on the user's PC or changes a client setting.

Revision 552020-01-23 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Revision 542013-06-06 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Changed:
<
<		This API can be used by an APPX designer to interact with the APPX Runtime Application (---) to gain access to extra functionality.
>
>		These APIs can be used by an APPX designer to interact with the APPX Runtime Application (---) to gain access to extra functionality. This page only lists the APIs that were introduced in Release 5.1. For a list of all APIs in the current release, go to the full list.
 

Revision 532013-05-01 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 11 to 11
 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

Changed:
<
<		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 results 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.
>
>		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 results 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. Note that the work field has a scope of 'Detached', and so will retain it's value from invocation to invocation, as well as across all invocation types.
  If the subroutine accepts parameters (i.e., READ, WRITE, APPEND to --- .STREAM OPEN), the parameters are case insensitive.

Revision 522012-04-12 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 321 to 321
 

.FILE COPY

Copies a file from one location to another, creating any required directories.

Changed:
<
<

.FILE CREATE

>
>

.FILE CREATE

  Creates the specified file.

.FILE CREATE ARCHIVE

Revision 512012-04-11 - JeanNeron

Line: 1 to 1
Changed:
<
<
META TOPICPARENT name="WebHome"
>
>
META TOPICPARENT name="APPX510Features"
 

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.

Revision 502012-04-10 - AlKalter

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

APPX Runtime Subroutine API

Line: 310 to 310
  Puts data on the system clipboard.
Changed:
<
<

.CLIENT UPLOAD FILE

>
>

.CLIENT UPLOAD FILE

  Uploads a file from the Client to the server.

Revision 492012-04-05 - BredaHennessy

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

APPX Runtime Subroutine API

Line: 11 to 11
 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

Changed:
<
<		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.
>
>		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 results 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.
 
Changed:
<
<		If the subroutine accepts parameters (ie, READ, WRITE, APPEND to --- .STREAM OPEN), the parameters are case insensitive.
>
>		If the subroutine accepts parameters (i.e., READ, WRITE, APPEND to --- .STREAM OPEN), the parameters are case insensitive.
  If the subroutine has required parameters and you do not PASS the correct number of parameters, the subroutine will issue a CANCEL identifying which parameter was missing.
Line: 124 to 124
 

WIDGET Routines

.WIDGET APPLY THEME

Changed:
<
<		Applies a GUI Theme to the the current image.
>
>		Applies a GUI Theme to the current image.
 

.WIDGET CNV CLR TO RGB

Converts an alpha/hex color code to decimal.

Line: 186 to 186
 

Conversion Routines

.CONVERT BYTES TO HEX

Changed:
<
<		Converts a field to hexidecimal characters.
>
>		Converts a field to hexadecimal characters.
 

.CONVERT HEX PR TO NUM

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

Line: 195 to 195
 Converts a decimal number to a hex pair of alpha characters.

.CONVERT SPLIT NUMBER

Changed:
<
<		Splits a number into it's whole and fractional parts.
>
>		Splits a number into its whole and fractional parts.
 

.CONVERT TEXT TO HTML

Line: 310 to 310
  Puts data on the system clipboard.
Changed:
<
<

.CLIENT UPLOAD FILE

>
>

.CLIENT UPLOAD FILE

  Uploads a file from the Client to the server.

File System Utilities Subroutines

File Manipulation Routines

Changed:
<
<		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).
>
>		These subroutines provide you with a way to manipulate files on the file system without having to check the O/S type (i.e., using 'cp' vs 'copy', or different kernel calls).
 

.FILE COPY

Copies a file from one location to another, creating any required directories.

Changed:
<
<

.FILE CREATE

>
>

.FILE CREATE

  Creates the specified file.

.FILE CREATE ARCHIVE

Line: 332 to 332
 Deletes the given file from the filesystem.

.FILE EXISTS

Changed:
<
<		Tests for the existance of the given file in the filesystem.
>
>		Tests for the existence of the given file in the filesystem.
 

.FILE EXTRACT ARCHIVE

Extracts all the files from a previously created archive.

Line: 340 to 340
  Creates the given directory and parent directories in the filesystem.
Changed:
<
<		.FILE MOVE
>
>

.FILE MOVE

  Moves a file or directory from one location to another, creating any required directories

.FILE RESTRUCT

Revision 482012-03-30 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

APPX Runtime Subroutine API

Line: 90 to 90
 

.UTIL PROCESS DD

Processes the Data Dictionary for the selected Application or File.

Changed:
<
<

.UTIL PROCSS QUERY REC

>
>

.UTIL PROCESS QRY REC

  Writes the current record to the Query pointer file.
Line: 254 to 254
  Return the type of operating system Appx is running on.
Changed:
<
<

.ENV GET PARENT PROCES

>
>

.ENV GET PARENT PROC

  Returns the name and type of the parent process.

.ENV GET PATH NAME

Returns the pathname of the requested APPX data file.

Changed:
<
<

.ENV GET PATH SEPARATR

>
>

.ENV GET PATH SEP

  Returns the directory separator character of the host operating system.

Revision 472012-03-30 - PeteBrower

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

APPX Runtime Subroutine API

Line: 164 to 164
 

.WIDGET SET INTO MWDGT

Copies the current --- WIDGET file to a memory file.

Added:
>
>

.WIDGET SET THEME

Sets the current Theme Name.

 

.WIDGET SHOW BY NAME

Shows previously hidden widgets.

Revision 462012-03-29 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

APPX Runtime Subroutine API

Line: 297 to 297
 

.CLIENT LOAD URL

Changed:
<
<		Loads a URL, Document or runs a command on the user's PC.
>
>		Loads a URL, document, runs a command on the user's PC or changes a client setting.
 

.CLIENT PLAY SOUND

Revision 452012-03-23 - AlKalter

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

APPX Runtime Subroutine API

Line: 15 to 15
  If the subroutine accepts parameters (ie, READ, WRITE, APPEND to --- .STREAM OPEN), the parameters are case insensitive.
Changed:
<
<		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.
>
>		If the subroutine has required parameters and you do not PASS the correct number of parameters, the subroutine will issue a CANCEL identifying which parameter was missing.
 

General Subroutines

Application Routines

Revision 442012-03-22 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

APPX Runtime Subroutine API

Line: 258 to 258
 

.ENV GET PATH NAME

Returns the pathname of the requested APPX data file.

Changed:
<
<

.ENV GET PATH SEPERATR

>
>

.ENV GET PATH SEPARATR

 
Changed:
<
<		Returns the directory seperator character of the host operating system.
>
>		Returns the directory separator character of the host operating system.
 

.ENV GET SCREEN SIZE

Revision 432012-03-12 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

APPX Runtime Subroutine API

Line: 36 to 36
 

.UTIL ADD USER

Adds a user to the Appx User file.

Added:
>
>

.UTIL ADD HOOK

Adds a record to the Hook file.

 

.UTIL CHECK SECURITY

Checks the security code for the specified user.

.UTIL CHG AUX PASS

Changes the Auxiliary password for the specified user.

Added:
>
>

.UTIL CHG HOOK

Changes fields on the Hook File.

 

.UTIL CHG USER

Changes fields on the Appx User File.

Line: 51 to 57
 

.UTIL COMPILE PROC

Compiles the specified Process Type/Name or Application.

Added:
>
>

.UTIL DEL USER

Deletes a user from the Appx User File.

.UTIL DEL HOOK

Deletes a record from the Hook File.

 

.UTIL FIELD GET

Retrieves the value of the specified field name.

Revision 422012-03-09 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

APPX Runtime Subroutine API

Line: 75 to 75
 

.UTIL MOD SCROLL BEHAV

This subroutine allows the user to select a record on a scrolling display by just clicking it.

Added:
>
>

.UTIL PROCESS DD

 
Added:
>
>		Processes the Data Dictionary for the selected Application or File.
 

.UTIL PROCSS QUERY REC

Writes the current record to the Query pointer file.

Revision 412012-03-08 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

APPX Runtime Subroutine API

Line: 48 to 48
 

.UTIL CLEAR PASS LIST

Clears any unfilled PASS requests.

Added:
>
>

.UTIL COMPILE PROC

Compiles the specified Process Type/Name or Application.

 

.UTIL FIELD GET

Retrieves the value of the specified field name.

Revision 402012-03-01 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

APPX Runtime Subroutine API

Line: 319 to 319
 

.FILE MAKE DIR

Creates the given directory and parent directories in the filesystem.

Changed:
<
<

.FILE MOVE

>
>		 .FILE MOVE
  Moves a file or directory from one location to another, creating any required directories
Added:
>
>

.FILE RESTRUCT

Restructures the specified file.

 

.FILE SPLIT FILENAME

Splits the filename from the file extension and returns both.

Revision 392012-03-01 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="WebHome"

APPX Runtime Subroutine API

Line: 301 to 301
 

.FILE COPY

Copies a file from one location to another, creating any required directories.

Added:
>
>

.FILE CREATE

Creates the specified file.

 

.FILE CREATE ARCHIVE

Creates an archive of the specified files, in either TAR or TGZ format.

Revision 382012-02-29 - JeanNeron

Line: 1 to 1
Changed:
<
<
META TOPICPARENT name="APPX510Features"
>
>
META TOPICPARENT name="WebHome"
 

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.

Line: 48 to 48
 

.UTIL CLEAR PASS LIST

Clears any unfilled PASS requests.

Added:
>
>

.UTIL FIELD GET

Retrieves the value of the specified field name.

 

.UTIL FIELD SET

Sets a value into the specified field name.

Revision 372012-02-28 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 48 to 48
 

.UTIL CLEAR PASS LIST

Clears any unfilled PASS requests.

Added:
>
>

.UTIL FIELD SET

Sets a value into the specified field name.

 

.UTIL GET EM NAME

For a given Process Type/Name, returns the Em name.

Revision 362012-02-27 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 42 to 42
 

.UTIL CHG AUX PASS

Changes the Auxiliary password for the specified user.

Added:
>
>

.UTIL CHG USER

Changes fields on the Appx User File.

 

.UTIL CLEAR PASS LIST

Clears any unfilled PASS requests.

Revision 352012-02-22 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 280 to 280
 

.CLIENT SET CLIPBOARD

Puts data on the system clipboard.

Changed:
<
<

>
>
 

.CLIENT UPLOAD FILE

Uploads a file from the Client to the server.

Revision 342012-02-21 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 33 to 33
 Switches to the specified database.

Utility Routines

Added:
>
>

.UTIL ADD USER

Adds a user to the Appx User file.

 

.UTIL CHECK SECURITY

Checks the security code for the specified user.

Added:
>
>

.UTIL CHG AUX PASS

 
Added:
>
>		Changes the Auxiliary password for the specified user.
 

.UTIL CLEAR PASS LIST

Clears any unfilled PASS requests.

Revision 332012-02-21 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 74 to 74
 

.UTIL SLEEP WITH TIMER

Pauses for the specified number of seconds with a countdown timer.

Added:
>
>

.UTIL SWITCH USER

Changes to a different user.

 

.UTIL TIMEOUT EXIT

Exits or logout a user after a set timeout period.

Line: 272 to 275
 

.CLIENT SET CLIPBOARD

Puts data on the system clipboard.

Changed:
<
<

.CLIENT SWITCH USER

Changes to a different user.

>
>

 

.CLIENT UPLOAD FILE

Uploads a file from the Client to the server.

Revision 322012-02-21 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 272 to 272
 

.CLIENT SET CLIPBOARD

Puts data on the system clipboard.

Added:
>
>

.CLIENT SWITCH USER

 
Added:
>
>		Changes to a different user.
 

.CLIENT UPLOAD FILE

Uploads a file from the Client to the server.

Revision 312012-02-14 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 121 to 121
 

.WIDGET HIDE STD MENUS

Hides the standard pull down menus.

Added:
>
>

.WIDGET MISSING THEME

Finds all Inputs/Menus that do not use .WIDGET APPLY THEME.

 

.WIDGET SET FROM MWDGT

Copies the memory file to --- WIDGET.

Revision 302012-02-13 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 88 to 88
  Populates Appx Variables from STDIN.

WIDGET Routines

Added:
>
>

.WIDGET APPLY THEME

Applies a GUI Theme to the the current image.

 

.WIDGET CNV CLR TO RGB

Converts an alpha/hex color code to decimal.

Revision 292012-02-10 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 183 to 183
 

.TEXT LOWER TO UPPER

Convert lower case to upper case in a text/alpha field.

Added:
>
>

.TEXT PARSE LINE

Parse a string into separate fields.

 

.TEXT UPPER TO LOWER

Convert upper case to lower case in a text/alpha field.

Revision 282012-02-10 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 173 to 173
 Find the position of text in a text/alpha field.

.TEXT FIND AND REPLACE

Changed:
<
<		Find and replace the given text in a given text or alpha field.
>
>		Find and replace text in a text/alpha field.
 

.TEXT GET LENGTH

Determine the length of a text/alpha field.

Revision 272012-02-09 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 164 to 164
 

Text Routines

.TEXT CREATE PAD

Changed:
<
<		Fills a field with a single charcter repeated the given number of times.
>
>		Fills a field with a single character.
 

.TEXT CUT AT POS

Changed:
<
<		Removes characters from a given text or alpha field.
>
>		Removes characters from a text/alpha field.
 

.TEXT FIND

Changed:
<
<		Find the position of the given text in a given text or alpha field.
>
>		Find the position of text in a text/alpha field.
 

.TEXT FIND AND REPLACE

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

.TEXT GET LENGTH

Changed:
<
<		Determine the length of text within a given text or alpha field.
>
>		Determine the length of a text/alpha field.
 

.TEXT INSERT AT POS

Changed:
<
<		Inserts text into a given text or alpha field.
>
>		Inserts characters into a text/alpha field.
 

.TEXT LOWER TO UPPER

Changed:
<
<		Convert lower case text to upper case text within a given text or alpha field.
>
>		Convert lower case to upper case in a text/alpha field.
 

.TEXT UPPER TO LOWER

Changed:
<
<		Convert upper case text to lower case text within a given text or alpha field.
>
>		Convert upper case to lower case in a text/alpha field.
 

System Information Subroutines

Server Environment Routines

.ENV GET APPXPATH

Revision 262012-02-07 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 88 to 88
  Populates Appx Variables from STDIN.

WIDGET Routines

Deleted:
<
<

.WIDGET APPLY DEFAULT

Does nothing useful.

 

.WIDGET CNV CLR TO RGB

Converts an alpha/hex color code to decimal.

Line: 108 to 105
 Deletes the scroll buttons from the toolbar.

.WIDGET DEL STD MENUS

Changed:
<
<		Checks the security code for the specified user.
>
>		Deletes the standard pull down menus.
 

.WIDGET HIDE BY NAME

Hides selected widgets.

Line: 120 to 117
 Hides the scroll buttons on the toolbar.

.WIDGET HIDE STD MENUS

Changed:
<
<		Checks the security code for the specified user.

.WIDGET SET DFLT THEME

Checks the security code for the specified user.

.WIDGET SET DFLT THEME

Checks the security code for the specified user.

>
>		Hides the standard pull down menus.
 

.WIDGET SET FROM MWDGT

Copies the memory file to --- WIDGET.

.WIDGET SET INTO MWDGT

Copies the current --- WIDGET file to a memory file.

Deleted:
<
<

.WIDGET SET RNTM THEME

Checks the security code for the specified user.

 

.WIDGET SHOW BY NAME

Shows previously hidden widgets.

Line: 147 to 135
 Shows previously hidden scroll buttons on the toolbar.

.WIDGET SHOW STD MENUS

Changed:
<
<		Checks the security code for the specified user.
>
>		Shows the previously hidden standard pull down menus.
 

.WIDGET VIEW RUNTIME

Shows properties of the current --- WIDGET file.

Revision 252012-02-07 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 129 to 129
 Checks the security code for the specified user.

.WIDGET SET FROM MWDGT

Changed:
<
<		Checks the security code for the specified user.
>
>		Copies the memory file to --- WIDGET.
 

.WIDGET SET INTO MWDGT

Changed:
<
<		Checks the security code for the specified user.
>
>		Copies the current --- WIDGET file to a memory file.
 

.WIDGET SET RNTM THEME

Checks the security code for the specified user.

Revision 242012-02-07 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 105 to 105
 Deletes the mode buttons from the toolbar.

.WIDGET DEL SCROLL BTN

Changed:
<
<		Checks the security code for the specified user.
>
>		Deletes the scroll buttons from the toolbar.
 

.WIDGET DEL STD MENUS

Checks the security code for the specified user.

.WIDGET HIDE BY NAME

Changed:
<
<		Checks the security code for the specified user.
>
>		Hides selected widgets.
 

.WIDGET HIDE MODE BTN

Changed:
<
<		Checks the security code for the specified user.
>
>		Hides the mode buttons on the toolbar.
 

.WIDGET HIDE SCROL BTN

Changed:
<
<		Checks the security code for the specified user.
>
>		Hides the scroll buttons on the toolbar.
 

.WIDGET HIDE STD MENUS

Checks the security code for the specified user.

Line: 138 to 138
 Checks the security code for the specified user.

.WIDGET SHOW BY NAME

Changed:
<
<		Checks the security code for the specified user.
>
>		Shows previously hidden widgets.
 

.WIDGET SHOW MODE BTN

Changed:
<
<		Checks the security code for the specified user.
>
>		Shows previously hidden mode buttons on the toolbar.
 

.WIDGET SHOW SCROL BTN

Changed:
<
<		Checks the security code for the specified user.
>
>		Shows previously hidden scroll buttons on the toolbar.
 

.WIDGET SHOW STD MENUS

Checks the security code for the specified user.

.WIDGET VIEW RUNTIME

Changed:
<
<		Checks the security code for the specified user.
>
>		Shows properties of the current --- WIDGET file.
 

Data Manipulation Subroutines

Conversion Routines

.CONVERT BYTES TO HEX

Revision 232012-02-06 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 90 to 90
 

WIDGET Routines

.WIDGET APPLY DEFAULT

Changed:
<
<		Checks the security code for the specified user.
>
>		Does nothing useful.
 

.WIDGET CNV CLR TO RGB

Changed:
<
<		Checks the security code for the specified user.
>
>		Converts an alpha/hex color code to decimal.
 

.WIDGET CNV RGB TO CLR

Changed:
<
<		Checks the security code for the specified user.
>
>		Converts a decimal color code to alpha/hex.
 

.WIDGET DEL BY NAME

Changed:
<
<		Checks the security code for the specified user.
>
>		Deletes selected widgets.
 

.WIDGET DEL MODE BTN

Changed:
<
<		Checks the security code for the specified user.
>
>		Deletes the mode buttons from the toolbar.
 

.WIDGET DEL SCROLL BTN

Checks the security code for the specified user.

Revision 222012-02-06 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 83 to 83
 

.UTIL UPDATE DOCUMENT

Update process documentation via ILF

Added:
>
>

Web Processing Routines

.IMPORT CGI DATA

 
Added:
>
>		Populates Appx Variables from STDIN.

WIDGET Routines

.WIDGET APPLY DEFAULT

Checks the security code for the specified user.

.WIDGET CNV CLR TO RGB

Checks the security code for the specified user.

.WIDGET CNV RGB TO CLR

Checks the security code for the specified user.

.WIDGET DEL BY NAME

Checks the security code for the specified user.

.WIDGET DEL MODE BTN

Checks the security code for the specified user.

.WIDGET DEL SCROLL BTN

Checks the security code for the specified user.

.WIDGET DEL STD MENUS

Checks the security code for the specified user.

.WIDGET HIDE BY NAME

Checks the security code for the specified user.

.WIDGET HIDE MODE BTN

Checks the security code for the specified user.

.WIDGET HIDE SCROL BTN

Checks the security code for the specified user.

.WIDGET HIDE STD MENUS

Checks the security code for the specified user.

.WIDGET SET DFLT THEME

Checks the security code for the specified user.

.WIDGET SET DFLT THEME

Checks the security code for the specified user.

.WIDGET SET FROM MWDGT

Checks the security code for the specified user.

.WIDGET SET INTO MWDGT

Checks the security code for the specified user.

.WIDGET SET RNTM THEME

Checks the security code for the specified user.

.WIDGET SHOW BY NAME

Checks the security code for the specified user.

.WIDGET SHOW MODE BTN

Checks the security code for the specified user.

.WIDGET SHOW SCROL BTN

Checks the security code for the specified user.

.WIDGET SHOW STD MENUS

Checks the security code for the specified user.

.WIDGET VIEW RUNTIME

Checks the security code for the specified user.

 

Data Manipulation Subroutines

Conversion Routines

.CONVERT BYTES TO HEX

Revision 212012-02-04 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 86 to 86
 

Data Manipulation Subroutines

Conversion Routines

Added:
>
>

.CONVERT BYTES TO HEX

Converts a field to hexidecimal characters.

 

.CONVERT HEX PR TO NUM

Changed:
<
<		Convert a hex pair of alpha characters to a decimal number.
>
>		Converts a hex pair of alpha characters to a decimal number.
 

.CONVERT NUM TO HEX PR

Changed:
<
<		Convert a decimal number to a hex pair of alpha characters.
>
>		Converts a decimal number to a hex pair of alpha characters.
 

.CONVERT SPLIT NUMBER

Changed:
<
<		Split a number into it's whole and fractional parts.
>
>		Splits a number into it's whole and fractional parts.

.CONVERT TEXT TO HTML

Converts a text field to HTML encoding

.CONVERT TRANSLATE

Converts a string from one language to another.

 

Text Routines

.TEXT CREATE PAD

Revision 202012-02-02 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 27 to 27
 Changes the current application to the 'Live Operations' phase.

.BEGIN RECOVERY PROCESSING

Changed:
<
<		Changes the current application to the 'Recovery Processing' phase
>
>		Changes the current application to the 'Recovery Processing' phase.

.SELECT DATABASE

Switches to the specified database.

 

Utility Routines

.UTIL CHECK SECURITY

Revision 192012-02-02 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 28 to 28
 

.BEGIN RECOVERY PROCESSING

Changes the current application to the 'Recovery Processing' phase

Changed:
<
<

RDBMS Routines

.RDBMS COMMIT

Commits all changes to RDBMS tables.

.RDBMS COMPATIBLE MODE

Commits all changes to RDBMS tables.

.RDBMS MANUAL LOCKING

Commits all changes to RDBMS tables.

.RDBMS PORTABLE MODE

Commits all changes to RDBMS tables.

.RDBMS READ COMMITTED

Commits all changes to RDBMS tables.

.RDBMS RELEASE

Commits all changes to RDBMS tables.

.RDBMS ROLLBACK

Commits all changes to RDBMS tables.

.RDBMS SERIALIZABLE

Commits all changes to RDBMS tables.

>
>

 

Utility Routines

.UTIL CHECK SECURITY

Revision 182012-02-02 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 18 to 18
 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

Added:
>
>

Application Routines

.BEGIN INITIAL SETUP

Changes the current application to the 'Initial Setup' phase.

.BEGIN LIVE OPERATIONS

Changes the current application to the 'Live Operations' phase.

.BEGIN RECOVERY PROCESSING

Changes the current application to the 'Recovery Processing' phase

RDBMS Routines

.RDBMS COMMIT

Commits all changes to RDBMS tables.

.RDBMS COMPATIBLE MODE

Commits all changes to RDBMS tables.

.RDBMS MANUAL LOCKING

Commits all changes to RDBMS tables.

.RDBMS PORTABLE MODE

Commits all changes to RDBMS tables.

.RDBMS READ COMMITTED

Commits all changes to RDBMS tables.

.RDBMS RELEASE

Commits all changes to RDBMS tables.

.RDBMS ROLLBACK

Commits all changes to RDBMS tables.

.RDBMS SERIALIZABLE

Commits all changes to RDBMS tables.

 

Utility Routines

.UTIL CHECK SECURITY

Revision 172012-02-01 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 168 to 168
  Gets the current content of the system clipboard.
Changed:
<
<

.CLIENT GET CONSTANT

>
>

.CLIENT GET CONSTANT

 
Changed:
<
<		Gets the content of the specified Client constant.
>
>		Returns the value of a client constant
 

.CLIENT LOAD URL

Revision 162012-01-31 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 150 to 150
 

.ENV VIEW LICENSE INFO

Displays the APPX license info for the current application.

Added:
>
>

Client Routines

.CLIENT CHECK FOR GUI

Returns a flag to indicate if the user is running the Desktop Client.

.CLIENT CHECK VERSION

Returns the version of the Desktop Client.

.CLIENT DOWNLOAD FILE

Downloads a file to the user's PC.

.CLIENT GET CLIPBOARD

Gets the current content of the system clipboard.

.CLIENT GET CONSTANT

Gets the content of the specified Client constant.

.CLIENT LOAD URL

Loads a URL, Document or runs a command on the user's PC.

.CLIENT PLAY SOUND

Plays a .wav file on the user's PC.

.CLIENT SET CLIPBOARD

Puts data on the system clipboard.

.CLIENT UPLOAD FILE

Uploads a file from the Client to the server.

 

File System Utilities Subroutines

File Manipulation Routines

Revision 152012-01-31 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 34 to 34
  Copies the engine Hook records into a temporary file for modification.
Deleted:
<
<

.UTIL KEYB TIMEOUT EXIT

Exits or logout a user after a set timeout period.

 

.UTIL LOAD STACK FILE

Loads --- STACK with the current process stack.

Line: 57 to 53
  Activates the hooks in the temporary file.
Deleted:
<
<

.UTIL SET KEYB TIMEOUT

Sets the keyboard timeout value.

 

.UTIL SLEEP

Pauses for the specified number of seconds.

Line: 68 to 60
 

.UTIL SLEEP WITH TIMER

Pauses for the specified number of seconds with a countdown timer.

Added:
>
>

.UTIL TIMEOUT EXIT

Exits or logout a user after a set timeout period.

.UTIL TIMEOUT SET

 
Added:
>
>		Sets the keyboard timeout value.
 

.UTIL UPDATE DOCUMENT

Update process documentation via ILF

Revision 142012-01-27 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 47 to 47
 Not Implemented

.UTIL MOD SCROLL BEHAV

Changed:
<
<		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.
>
>		This subroutine allows the user to select a record on a scrolling display by just clicking it.
 
Changed:
<
<

.UTIL PROCESS QUERY REC

>
>

.UTIL PROCSS QUERY REC

  Writes the current record to the Query pointer file.

Revision 132012-01-27 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 32 to 32
 

.UTIL GET HOOK RECORDS

Changed:
<
<		Copies the engine Hook records into a temp file.
>
>		Copies the engine Hook records into a temporary file for modification.
 

.UTIL KEYB TIMEOUT EXIT

Revision 122012-01-27 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 19 to 19
 

General Subroutines

Utility Routines

Changed:
<
<

.UTIL MOD SCROLL BEHAV

>
>

.UTIL CHECK SECURITY

 
Changed:
<
<		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.
>
>		Checks the security code for the specified user.

.UTIL CLEAR PASS LIST

Clears any unfilled PASS requests.

 

.UTIL GET EM NAME

For a given Process Type/Name, returns the Em name.

Added:
>
>

.UTIL GET HOOK RECORDS

Copies the engine Hook records into a temp file.

.UTIL KEYB TIMEOUT EXIT

Exits or logout a user after a set timeout period.

.UTIL LOAD STACK FILE

Loads --- STACK with the current process stack.

.UTIL MAKE DYNAMIC KEY

Not Implemented

.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.

.UTIL PROCESS QUERY REC

Writes the current record to the Query pointer file.

.UTIL PUT HOOK RECORDS

Activates the hooks in the temporary file.

.UTIL SET KEYB TIMEOUT

Sets the keyboard timeout value.

.UTIL SLEEP

Pauses for the specified number of seconds.

.UTIL SLEEP WITH TIMER

Pauses for the specified number of seconds with a countdown timer.

.UTIL UPDATE DOCUMENT

Update process documentation via ILF

 

Data Manipulation Subroutines

Conversion Routines

.CONVERT HEX PR TO NUM

Revision 112012-01-27 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 92 to 92
 Returns the pathname of the requested APPX data file.

.ENV GET PATH SEPERATR

Changed:
<
<		Return the directory seperator character of the host operating system.
>
>		Returns the directory seperator character of the host operating system.
 

.ENV GET SCREEN SIZE

Line: 104 to 104
 

.ENV VIEW LICENSE INFO

Changed:
<
<		Views the APPX license info about this installation (GUI Only).
>
>		Displays the APPX license info for the current application.
 

File System Utilities Subroutines

File Manipulation Routines

Revision 102012-01-26 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 83 to 83
  Return the type of operating system Appx is running on.
Changed:
<
<

.ENV GET PARENT PROCESS

>
>

.ENV GET PARENT PROCES

  Returns the name and type of the parent process.

Revision 92012-01-25 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

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

System Information Subroutines

Server Environment Routines

Added:
>
>

.ENV GET APPXPATH

Returns the path to the location of Appx data files.

.ENV GET CMD LINE PARM

Returns the value of a command line parameter.

.ENV GET CONFIG INFO

Populates PDF fields with configuration information.

.ENV GET ENV VARIABLE

Returns the value of an environment variable.

 

.ENV GET OS TYPE

Return the type of operating system Appx is running on.

Added:
>
>

.ENV GET PARENT PROCESS

Returns the name and type of the parent process.

.ENV GET PATH NAME

Returns the pathname of the requested APPX data file.

 

.ENV GET PATH SEPERATR

Return the directory seperator character of the host operating system.

Added:
>
>

.ENV GET SCREEN SIZE

Returns the size of the Appx screen in rows and columns.

.ENV SET ENV VARIABLE

Sets the value of an environment variable (not yet implemented).

.ENV VIEW LICENSE INFO

Views the APPX license info about this installation (GUI Only).

 

File System Utilities Subroutines

File Manipulation Routines

Revision 82012-01-25 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 71 to 71
 Return the directory seperator character of the host operating system.

File System Utilities Subroutines

File Manipulation Routines

Added:
>
>		 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).
 

.FILE COPY

Copies a file from one location to another, creating any required directories.

Line: 91 to 93
 Creates the given directory and parent directories in the filesystem.

.FILE MOVE

Changed:
<
<		Moves a file from one location to another, creating any required directories
>
>		Moves a file or directory from one location to another, creating any required directories
 

.FILE SPLIT FILENAME

Splits the filename from the file extension and returns both.

Line: 99 to 101
  Splits the filename from the path and returns both.

Stream File Routines

Added:
>
>		 The stream routines provide a way to work directly with text files, or to get the standard output of a command (via pipes).
 

.STREAM CLOSE

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

Revision 72012-01-24 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 71 to 71
 Return the directory seperator character of the host operating system.

File System Utilities Subroutines

File Manipulation Routines

Added:
>
>

.FILE COPY

Copies a file from one location to another, creating any required directories.

.FILE CREATE ARCHIVE

Creates an archive of the specified files, in either TAR or TGZ format.

 

.FILE DELETE

Deletes the given file from the filesystem.

.FILE EXISTS

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

Added:
>
>

.FILE EXTRACT ARCHIVE

Extracts all the files from a previously created archive.

 

.FILE MAKE DIR

Creates the given directory and parent directories in the filesystem.

Added:
>
>

.FILE MOVE

Moves a file from one location to another, creating any required directories

 

.FILE SPLIT FILENAME

Splits the filename from the file extension and returns both.

Revision 62012-01-23 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 8 to 8
 

Overview

Changed:
<
<		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.
>
>		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.

Added:
>
>		 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

.UTIL MOD SCROLL BEHAV

Revision 52011-09-27 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 17 to 17
 

.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.

Added:
>
>

.UTIL GET EM NAME

For a given Process Type/Name, returns the Em name.

 

Data Manipulation Subroutines

Conversion Routines

.CONVERT HEX PR TO NUM

Revision 42011-09-13 - JeanNeron

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 11 to 11
 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

Changed:
<
<		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.
>
>		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.
 

General Subroutines

Utility Routines

.UTIL MOD SCROLL BEHAV

Revision 32011-08-12 - PeteBrower

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 69 to 69
 

.FILE EXISTS

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

Changed:
<
<

.FILE MAKE DIR

>
>

.FILE MAKE DIR

  Creates the given directory and parent directories in the filesystem.
Changed:
<
<

.FILE SPLIT FILENAME

>
>

.FILE SPLIT FILENAME

  Splits the filename from the file extension and returns both.
Changed:
<
<

.FILE SPLIT PATHNAME

>
>

.FILE SPLIT PATHNAME

  Splits the filename from the path and returns both.

Stream File Routines

Revision 22011-08-12 - PeteBrower

Line: 1 to 1
 
META TOPICPARENT name="APPX510Features"

APPX Runtime Subroutine API

Line: 12 to 12
 

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.

Added:
>
>

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

Line: 23 to 28
 

.CONVERT SPLIT NUMBER

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

Added:
>
>

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

Line: 31 to 61
 

.ENV GET PATH SEPERATR

Return the directory seperator character of the host operating system.

Added:
>
>

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

Revision 12011-08-12 - PeteBrower

Line: 1 to 1
Added:
>
>
META TOPICPARENT name="APPX510Features"

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.

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.

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.

-- PeteBrower - 2011-08-12

View topic | History: r59 < r58 < r57 < r56 | More topic actions...
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback