Difference: APPXRuntimeSubroutineAPI (48 vs. 49)

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

 
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