Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
APPX Runtime Subroutine APIThis page lists all the available API's in the current version of Appx. Various API's have been released at different times and are documented in the release notes for that release, this page lists all of them in one location. The initial set of API's was released in version 5.1.
General InformationAll 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. 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 SubroutinesApplication Routines.BEGIN INITIAL SETUPChanges the current application to the 'Initial Setup' phase..BEGIN LIVE OPERATIONSChanges the current application to the 'Live Operations' phase..BEGIN RECOVERY PROCESSINGChanges the current application to the 'Recovery Processing' phase..SELECT DATABASESwitches to the specified database.Utility Routines.UTIL ADD USERAdds a user to the Appx User file..UTIL ADD HOOKAdds a record to the Hook file..UTIL CHECK RBSChecks the security access for the specified user when Role Based Security is used..UTIL CHECK SECURITYChecks the security code for the specified user..UTIL CHG AUX PASSChanges the Auxiliary password for the specified user..UTIL CHG HOOKChanges fields on the Hook File..UTIL CHG USERChanges fields on the Appx User File..UTIL CLEAR PASS LISTClears any unfilled PASS requests..UTIL COMPILE PROCCompiles the specified Process Type/Name or Application..UTIL COMPUTE HASHComputes the SHA-2 hash value of the given string.UTIL DEL USERDeletes a user from the Appx User File..UTIL DEL HOOKDeletes a record from the Hook File..UTIL EMAILSends an Email..UTIL FIELD GETRetrieves the value of the specified field name..UTIL FIELD SETSets a value into the specified field name..UTIL GET EM NAMEFor a given Process Type/Name, returns the Em name..UTIL GET HOOK RECORDSCopies the engine Hook records into a temporary file for modification..UTIL GET MESSAGESPopulates the --- MESSAGES file with any messages that were issued.UTIL KILL SESSIONCancels the specified process.UTIL LOAD STACK FILELoads --- STACK with the current process stack..UTIL MAKE DYNAMIC KEYNot Implemented.UTIL MARK SETMarks a process so you can return to it immediately via .UTIL MARK REWIND.UTIL MARK REWINDReturns immediately to a previously marked process, closing all processes in between..UTIL MOD SCROLL BEHAVThis subroutine allows the user to select a record on a scrolling display by just clicking it..UTIL PROCESS DDProcesses the Data Dictionary for the selected Application or File..UTIL PROCESS QRY RECWrites the current record to the Query pointer file..UTIL PUT HOOK RECORDSActivates the hooks in the temporary file..UTIL SECR RESTRestores Security codes from the archive.UTIL SECR SAVESaves Security codes to the archive.UTIL SLEEPPauses for the specified number of seconds..UTIL SLEEP WITH TIMERPauses for the specified number of seconds with a countdown timer..UTIL SUBR CLOSECloses the subroutine you created using .UTIL SUBR CREATE.UTIL SUBR CREATEAdds a subroutine to the specified application..UTIL SUBR DELETEDeletes a subroutine from the application..UTIL SUBR WRITE ILFWrites ILF code to a subroutine in the Application..UTIL SWITCH USERChanges to a different user..UTIL TIMEOUT EXITExits or logout a user after a set timeout period..UTIL TIMEOUT SETSets the keyboard timeout value..UTIL UPDATE DOCUMENTUpdate process documentation via ILFXML Processing Routines.XML IMPORTProcesses an XML file and optionally imports it..XML PURGEDeletes the work files used by a particular import session..XML WRITER OPENCreates and opens an XML file on the server and adds <?xml?> to it..XML WRITER CLOSECloses an XML file and frees up memory used by XML Writer..XML WRITER ELEM STARTOpens an element in an XML file..XML WRITER ELEM ENDCloses the most recent opened element in an XML file.XML WRITER ADD DATAAdds data to the most recent opened element in an XML file..XML WRITER CDAT STARTOpens a cdata element in an XML file | ||||||||
Changed: | ||||||||
< < | .XML WRITER CDAT END | |||||||
> > | .XML WRITER CDAT END | |||||||
Adds cdata end tag to an XML file
.XML WRITER ADD ATTRAdds an attribute name, value pair to the most recent opened element in an XML file.JSON Processing Routines.JSON PARSEProcesses a JSON string and imports it..JSON PARSE FILEProcesses a JSON file and imports it.Web Processing Routines.IMPORT CGI DATAPopulates Appx Variables from STDIN.WIDGET Routines.WIDGET APPLY THEMEApplies a GUI Theme to the current image..WIDGET CNV CLR TO RGBConverts an alpha/hex color code to decimal..WIDGET CNV RGB TO CLRConverts a decimal color code to alpha/hex..WIDGET COUNT ROWSReturns the count of selected rows in the specified table widget.WIDGET DEL BY NAMEDeletes selected widgets..WIDGET DEL MODE BTNDeletes the mode buttons from the toolbar..WIDGET DEL SCROLL BTNDeletes the scroll buttons from the toolbar..WIDGET DEL STD MENUSDeletes the standard pull down menus..WIDGET HIDE BY NAMEHides selected widgets..WIDGET HIDE MODE BTNHides the mode buttons on the toolbar..WIDGET HIDE SCROL BTNHides the scroll buttons on the toolbar..WIDGET HIDE STD MENUSHides the standard pull down menus..WIDGET MISSING THEMEFinds all Inputs/Menus that do not use .WIDGET APPLY THEME..WIDGET RELOAD DATASRCReloads all the data in a Table Widget.WIDGET SET FROM MWDGTCopies the memory file to --- WIDGET..WIDGET SET INTO MWDGTCopies the current --- WIDGET file to a memory file..WIDGET SET THEMESets the current Theme Name..WIDGET SET TOOLTIPSets or clears the tooltip for selected widgets.WIDGET SHOW BY NAMEShows previously hidden widgets..WIDGET SHOW MODE BTNShows previously hidden mode buttons on the toolbar..WIDGET SHOW SCROL BTNShows previously hidden scroll buttons on the toolbar..WIDGET SHOW STD MENUSShows the previously hidden standard pull down menus..WIDGET VIEW RUNTIMEShows properties of the current --- WIDGET file.Data Manipulation SubroutinesConversion Routines.CONVERT BYTES TO HEXConverts a field to hexadecimal characters..CONVERT HEX PR TO NUMConverts a hex pair of alpha characters to a decimal number..CONVERT HTML TO TEXTConverts HTML text to plain APPX text.CONVERT NUM TO HEX PRConverts a decimal number to a hex pair of alpha characters..CONVERT SPLIT NUMBERSplits a number into its whole and fractional parts..CONVERT TEXT TO HTMLConverts a text field to HTML encoding.CONVERT TRANSLATEConverts a string from one language to another..CONVERT TO BASE64Converts Appx raw data to Base64 data..CONVERT FROM BASE64Converts Base64 data to Appx raw data.Text Routines.TEXT CREATE PADFills a field with a single character..TEXT CUT AT POSRemoves characters from a text/alpha field..TEXT FINDFind the position of text in a text/alpha field..TEXT FIND AND REPLACEFind and replace text in a text/alpha field..TEXT FROM UNICODETranscodes the specified text from a Unicode field to a RAW Field..TEXT GET LENGTHDetermine the length of a text/alpha field..TEXT GET UNINAMEReturns the name of the given Unicode character..TEXT INSERT AT POSInserts characters into a text/alpha field..TEXT LOWER TO UPPERConvert lower case to upper case in a text/alpha field..TEXT PARSE LINEParse a string into separate fields..TEXT SET UNINAMEReturns the named Unicode character.TEXT TO UNICODETranscodes the RAW text to a Unicode field..TEXT UNICODE COMPCompares 2 Unicode fields..TEXT UPPER TO LOWERConvert upper case to lower case in a text/alpha field.System Information SubroutinesServer Environment Routines.ENV GET APPXPATHReturns the path to the location of Appx data files..ENV GET CMD LINE PARMReturns the value of a command line parameter..ENV GET CONFIG INFOPopulates PDF fields with configuration information..ENV GET ENCODINGSPopulates the --- ENCODINGS file..ENV GET ENV VARIABLEReturns the value of an environment variable..ENV GET ENV (ALL)Returns the value of all environment variables..ENV GET OS TYPEReturn the type of operating system Appx is running on..ENV GET PARENT PROCReturns the name and type of the parent process..ENV GET PATH NAMEReturns the pathname of the requested APPX data file..ENV GET PATH SEPReturns the directory separator character of the host operating system..ENV GET SCREEN SIZEReturns the size of the Appx screen in rows and columns..ENV SET ENV VARIABLESets the value of an environment variable (not yet implemented)..ENV VIEW LICENSE INFODisplays the APPX license info for the current application.Client Routines.CLIENT CHECK FOR GUIReturns a flag to indicate if the user is running the Desktop Client..CLIENT CHECK VERSIONReturns the version of the Desktop Client..CLIENT DISPLAY FILEDownloads and opens a file on the user's PC..CLIENT DOWNLOAD FILEDownloads a file to the user's PC..CLIENT GET CLIPBOARDGets the current content of the system clipboard..CLIENT GET CONSTANTReturns the value of a client constant.CLIENT LOAD URLLoads a URL, document, runs a command on the user's PC or changes a client setting..CLIENT PLAY SOUNDPlays a .wav file on the user's PC..CLIENT SET CLIPBOARDPuts data on the system clipboard..CLIENT UPLOAD FILEUploads a file from the Client to the server.File System Utilities SubroutinesFile Manipulation RoutinesThese 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 COPYCopies a file from one location to another, creating any required directories..FILE CREATECreates the specified file..FILE CREATE ARCHIVECreates an archive of the specified files, in either TAR or TGZ format..FILE CSV EXPORTExports the specified File to CSV format..FILE CSV IMPORTImports a CSV formatted file into the specified APPX file..FILE DELETEDeletes the given file from the filesystem..FILE EXISTSTests for the existence of the given file in the filesystem..FILE EXTRACT ARCHIVEExtracts all the files from a previously created archive..FILE MAKE DIRCreates the given directory and parent directories in the filesystem..FILE MOVEMoves a file or directory from one location to another, creating any required directories.FILE RESTRUCTRestructures the specified file..FILE SET SPECSSets the file specifications.FILE SPLIT FILENAMESplits the filename from the file extension and returns both..FILE SPLIT PATHNAMESplits the filename from the path and returns both.Stream File RoutinesThe stream routines provide a way to work directly with text files, or to get the standard output of a command (via pipes)..STREAM CLOSECloses a file stream and frees up the stream resources for that file..STREAM CLOSE ALLCloses all file streams and frees up the stream resources for those files..STREAM OPENOpens a stream to the given file creating the file and path as needed..STREAM READRead data from the given stream..STREAM WRITEWrite data to the given stream.Role Based Security RoutinesThe Role Based Security routines provide a way for you to add RBS maintenance capabilities to your applications. This can be useful if you want your users to maintain RBS but do not want to give them full System Administrator access..RBS HIERARCHY MTCEInvokes the 'Security Hierarchy Maintenance' program, bypassing the System Administrator requirement (System Administration -> Role Based Security -> Security Hierarchy Maintenance)..RBS PROCESS SECURITYAllows the designer to invoke ' Access Control List - Processes' for a particular parent / child pair (System Administration -> Role Based Security -> Access Control List - Processes)..RBS REGENRebuilds the internal RBS cross reference file for the selected apps..RBS UPDATE SECACLAllows the designer to update the RBS Access Control file directly.Data API SubroutinesThese subroutines are only useful when working with the Data API in Release 5.5.0 and higher..DATA DEBUG LOGUse this subroutine to write a free format message to the debug log..DATA WRITE STREAMUse this to return results to the caller..DATA GET PARAM VALUEUse this to get the value of a parameter from the URL..DATA BAD REQUESTUse this to return a free format error message to the caller. -- JeanNeron - 2013-05-28 \ No newline at end of file |