Xbasic

Developer Functions

Description

Alpha Anywhere provides the following functions that will be useful to the Alpha Anywhere application developer.

Name
Description
A5_ASCII_TABLE Function

The A5_ASCII_TABLE() function displays an ASCII character table.

A5_AXCONTROL_AVAILABLE Function

The A5_AXCONTROL_AVAILABLE() function tests to see if the ActiveX control specified by ProgID is installed and registered on the current computer.

A5_Compile_Scripts Function

Displays the Compile Scripts dialog box. The A5_Compile_Scripts() function displays the Compile Script Library dialog.

A5_CREATE_SHORTCUT Function

Bring up the shortcut genie. restriction_flags are "N" (Don't create shortcut), "U" (No UI Message Boxes), "P" (No paths). lInstall should be .T. if calling from the install package creator.

A5_GET_LOCAL_INFO Function

The A5_GET_LOCAL_INFO() function returns information about a system configuration.

A5_GetAppVersionNumber Function

The A5_GetAppVersionNumber() function returns the application's version number.

A5_InstallAmyuni Function

The A5_InstallAmyuni() function installs the Alpha Anywhere printer drivers. You can specify an optional folder where the InstallAmyuniPrinters.exe file is located.

A5_IS_DeskTopEdition Function

The A5_IS_DeskTopEdition() function returns .T. if the Alpha Five Desktop Edition version is running.

A5_IS_RUNTIME Function

The A5_IS_RUNTIME() function returns .T. if the Alpha Five Runtime or Runtime Plus version is running.

A5_IS_RUNTIMEPLUS Function

The A5_IS_RUNTIMEPLUS() function indicates whether the running application is based on Alpha Five Runtime Plus. Returns .t. if the Runtime version is the 'Plus' edition

A5_IsHomeEdition Function

The A5_IsHomeEdition() function indicates whether the running program is the Alpha Five Home Edition. Returns .t. if user is running the Home edition

A5_MDAC_VERSION Function

The A5_MDAC_VERSION() function returns the version number of the installed MDAC ( Microsoft Data Access Components ). If MDAC is not installed, the function returns a blank string. MDAC is required for the IMPORT_ODBC_TABLE() function.

A5_REGISTRATION_LICENSE_INUSE Function

Return the number of users logged in via a .muf file, optional license key if checking a *different* installation (for example runtime).

A5_Run_VBScript Function

The A5_Run_VBScript() function runs VBScript code and returns VBScript error messages.

A5_SetAppVersionNumber Function

The A5_SetAppVersionNumber() function sets an application's version number. This is the same version number that can be set on the Network Optimization dialog.

A5_SHOW_VARIABLE Function

The A5_SHOW_VARIABLE() displays a dialog box with tabs showing the values of each of the currently defined variables.

A5_SYSTEM_ADDIN_VERSION Function

The A5_SYSTEM_ADDIN_VERSION() function returns the version number of the installed addin functions.

A5_TempFileListFileName Function

The A5_TempFileListFileName() function returns the name of the file that contains the temp file list.

COMPILE_LIBRARY Function

The COMPILE_LIBRARY() function compiles selected libraries into an executable .AEX file. Compile one or more libraries in a CRLF separated list from .ALB to .AEX, lib created is lib_num 0-255, if optional smart flag is set to TRUE than compiles will occur only if needed, ddfilter is an optional expression to only put elements that match filter in the AEX.

COMPILE_TEMPLATE Function

Create a compiled Xbasic code object. The COMPILE_TEMPLATE() function allows you to define a series of functions that are stored in a string. You would use this function when you want to use a function in more than one script, but do not want to redefine it as part of each script. This technique is a very powerful alternative to creating global functions.

FUNCTION_DESCRIPTION_GET Function

The FUNCTION_DESCRIPTION_GET function returns the description of a function.

FUNCTION_LIMITATIONS_GET Function

The FUNCTION_LIMITATIONS_GET() function returns the limitations of the named function.

FUNCTION_PROTOTYPE_GET Function

The FUNCTION_PROTOTYPE_GET() function returns the prototype for the named function.

FUNCTIONS_GET Function

The FUNCTIONS_GET() function returns a list of function prototypes - types of '*' means all types, Limitations F=functions,X=Xbasic,G=graphic.

HOURGLASS_CURSOR Function

HOURGLASS_CURSOR() turns on an hourglass cursor to indicate to the user that a task is being performed, and that he/she should wait until the task is complete. If On_Off_Flag is .T., the hourglass cursor is turned on. If On_Off_Flag is .F., the normal cursor is restored. Use this command in scripts before a long operation is started.

ON_XBASIC_IDLE Function

The ON_XBASIC_IDLE() function register Xbasic code that will be run the next time Alpha Anywhere is idle. (i.e. after any scripts that are running asynchronously have finished). You would typically use this command if you have script that is running into timing problems. To run code when Xbasic is not busy executing use flags R-epeat suppress, N-ested idles. The suppress repeats flag doesn't add the code if the exact same code is already scheduled.

PLAY_SOUND Function

PLAY_SOUND() plays a sound file (.WAV extension).

USER_VARIABLES_ENUM Function

The USER_VARIABLES_ENUM() function returns a CR-LF delimited list of user variables in the variable frame referenced by Pointer.

VARIABLE_CONTEXT_NAME Function

The VARIABLE_CONTEXT_NAME() function returns the name of the variable frame (if any) of the referenced variable.

VERSION Function

VERSION() returns the version number and other information about Alpha Anywhere. If flag is NULL, returns the major version number. E.g "5".

Xbasic_Stack_Dump Function

The Xbasic_Stack_Dump() function returns a stack dump. - optional format L=line,S=scriptname,N=line number,D=depth,W=With depth.

XBASIC_TRACE_END Function

The XBASIC_TRACE_END() function terminates writing Xbasic debug information to a file.

XBASIC_TRACE_START Function

The XBASIC_TRACE_START() function writes all debuggable executed Xbasic code lines to a file.