Previous Topic

Next Topic

Book Contents

Book Index

Environment Functions

Function

Description

AllowInteractive

Sets IsInteractive, and returns the previous value of IsInteractive if successful.

ChequeNo

Returns the cheque number assigned to the current AP cheque or remittance advice.

ClientName

Returns the WTSClientName if running in a Remote Desktop session, otherwise returns the MachineName.

ComputerName

Returns the name of the running computer as configured in Windows.

CopyFile

Copies a specified source file to a specified destination file, optionally overwriting the destination file.

CopyFromClipboard

Copies the contents of the Windows clipboard as text.

CopyToClipboard

 

Copies a string, number, date or boolean parameter to the Windows clipboard.

DeleteFile

Delete a specified file.

DesktopHeight

Returns the height of Windows desktop in pixels.

DesktopWidth

Returns the width of Windows desktop in pixels.

DirectoryExists

Returns True if the specified directory exists.

DisableUserAccessCheck

Inactivates the User Access Check for the current session.

EnableUserAccessCheck

Activates the User Access Check for the current session if it was inactivated.

FileExists

Returns True if the specified file exists.

GetAccredoDefaultPrinter

Returns the name of the Accredo Default Printer.

GetConfigValue

Gets the variable for a string from the file specified in LoadConfig and returns the value.

GetEnumText

Returns the Enum text for an Enum value.

GetEnvironmentVariable

Returns the value of an Environment Variable.

GetLicenseID

Returns the license session ID.

GetLicensesAvailable

Returns the number of user licenses.

GetLicensesCount

Returns the number of licenses currently available for a license group.

GetTickCount

Gets the system tick count (in milliseconds).

HTMLAvailable

Returns True if User Setting for Mail Format is HTML and work station preference for Mail Integration is not Simple MAPI or Use SMTP Mailing is selected, or False.

IsInteractive

Returns the value of IsInteractive.

IsWebService

Is WebService mode.

LoadConfig

Loads the file specified, so GetConfigValue can read the variables inside.

MemoryTotalAllocated

Returns total allocated memory.

MemoryTotalCommitted

Returns total OS committed memory.

MemoryTotalFree

Returns total free memory.

MemoryTotalMemory

Returns total program memory.

ModuleAvailable

Returns True if the module specified by ModuleCode is installed in the Company, or returns False.

OpenPDF

Open PDF File in default viewer.

PrinterList

Returns a list of available printers.

RenameFile

Rename a file.

SessionCode

Returns the session type for the current user.

SetAccredoDefaultPrinter

Sets the Accredo Default Printer to a specified printer.

SetConfigValue

Set a configuration value.

SetEnvironmentVariable

Sets the value of an Environment Variable.

Shell

Executes the external program Command.

ShowSQLProgress

Controls display of the progress bar in SQL Queries.

TempFileName

Returns the name a new temporary file.

TerminalServer

Returns True if the client is running a Remote Desktop Host session.

TryInteractive

Attempts to switch to IsInteractive, and returns the result.

UseWindowsDefaultPrinter

Sets the Accredo Default Printer to the Windows Default Printer.

ViewPDF

View PDF File.

ViewWindowPDF

View PDF File in a Floating Window.

WaitCursor

Set the application to an hour glass to provide UI feedback during a script.

In This Section

AllowInteractive - MaxBasic Function

ChequeNo - MaxBasic Function

ClientName - MaxBasic Function

ComputerName - MaxBasic Function

CopyFile - MaxBasic Function

CopyFromClipboard - MaxBasic Function

CopyToClipboard - MaxBasic Function

DeleteFile - MaxBasic Function

DesktopHeight - MaxBasic Function

DesktopWidth - MaxBasic Function

DirectoryExists - MaxBasic Function

DisableUserAccessCheck - MaxBasic Function

EnableUserAccessCheck - MaxBasic Function

FileExists - MaxBasic Function

GetAccredoDefaultPrinter - MaxBasic Function

GetConfigValue - MaxBasic Function

GetEnumText - MaxBasic Function

GetEnvironmentVariable - MaxBasic Function

GetLicenseID - MaxBasic Function

GetLicensesAvailable - MaxBasic Function

GetLicensesCount - MaxBasic Function

GetTickCount - MaxBasic Function

HTMLAvailable - MaxBasic Function

IsInteractive - MaxBasic Function

IsWebService - MaxBasic Function

LoadConfig - MaxBasic Function

MemoryTotalAllocated - MaxBasic Function

MemoryTotalCommitted - MaxBasic Function

MemoryTotalFree - MaxBasic Function

MemoryTotalMemory - MaxBasic Function

ModuleAvailable - MaxBasic Function

OpenPDF - MaxBasic Function

PrinterList - MaxBasic Function

RenameFile - MaxBasic Function

SessionCode - MaxBasic Function

SetAccredoDefaultPrinter - MaxBasic Function

SetConfigValue - MaxBasic Function

SetEnvironmentVariable - MaxBasic Function

Shell - MaxBasic Function

ShowSQLProgress - MaxBasic Function

TempFileName - MaxBasic Function

TerminalServer - MaxBasic Function

TryInteractive - MaxBasic Function

UseWindowsDefaultPrinter - MaxBasic Function

ViewPDF - MaxBasic Function

ViewWindowPDF - MaxBasic Function

WaitCursor - MaxBasic Function