Function Reference

Examples are not always provided for any function flagged as "deprecated".
Functions noted as being for advanced users only may not have examples.

Ack Acknowledge an alarm.
AckAllAlarms Acknowledge all unacknowledged alarms available to the current user.
AckAllAlarmsPlusDlg Acknowledge all unacknowledged alarms available to the current user after confirmation
AddToList Adds an alarm to the specified list in an Alarm Database, usually a custom list.
AdHocAlarm Evaluates an ad hoc alarm
AlarmCondition Returns TRUE (1) if the monitored tag has an active alarm.
AlarmUnAckCondition Returns TRUE (1) if the monitored tag has an unacknowledged alarm.
Commission (Alarm Manager module) Commission the alarm by adding it to the Configured list.
Decommission (Alarm Manager module) Decommission an alarm by name.
EvaluateAlarm (Alarm Manager module) Passes a new value to an alarm, to be compared to the setpoint.
GetAlarmConfiguration (Alarm Manager module) Returns a copy of an alarm's configuration structure from the master alarm list, creating it if it does not already exist.
GetAlarmList (Alarm Manager module) Returns filtered lists of records from alarm databases.
GetAlarmObject (Alarm Manager module) Returns an alarm object value given an alarm name.
GetAlarmStat Returns the number of alarms in the given tag and its descendents, where those alarms match the specified statistic.
GetAlarmStateStats (Alarm Manager module) Returns a structure containing the cumulative alarm state statistics for the specified tag.
GetAlarmStatus (Alarm Manager module) Returns a reference to an alarm's status structure in the master database, providing access the alarm's current state without having to make additional function calls.
GetContainerNumActive Returns the number of active alarms within a hierarchy of tags.
GetContainerNumUnacked Returns the number of unacknowledged alarms within a hierarchy of tags.
GetNameOfRecord (Alarm Manager module) Given an alarm record, returns the tag name.

GetNumUnacked

(Alarm Manager module) Returns either the number of unacknowledged alarms or a Yes/No flag to indicate that the alarms exist. If realm-area filtering is in use, results will be limited to the operator's realm.
GetUserNameOfRecord (Alarm Manager module) Given an alarm record, returns the user name associated with the transaction.

IsActive

(Alarm Manager module) Will indicate if an alarm is currently active.

IsDisabled

(Alarm Manager module) Will indicate if an alarm is currently disabled.
IsShelved (Alarm Manager module) Will indicate if an alarm is currently shelved. It can be used either as a subroutine or as a called function.
IsSuppressed

(Alarm Manager module) Will indicate if an alarm is currently suppressed.

IsUnacked

(Alarm Manager module) Will indicate if an alarm is currently unacknowledged.
MakeAlarmRecordSpeechFile Generates a .wav file from an alarm record to audibly speak an alarm.

MuteSound

(Alarm Manager module) This subroutine is used to turn off alarms sounds for all alarms, both current and future.

PAlmPriority

(VTS Library) Draws a droplist of the currently available alarm priorities with an optional title or bevel or both.
RemoveFromList Removes an alarm from the specified list in an Alarm Database, usually a custom list.
SetShelved AlarmManager plug-in, that handles the shelving and unshelving of alarms.

SilenceSound

(Alarm Manager module) This subroutine will silence the current sounding alarm.
The following alarm functions are deprecated or obsolete as of version 11.2

Acknowledge

Deprecated. (Alarm Manager module) Will acknowledge an alarm.

Active

Deprecated. (Alarm Manager module) Tells the Alarm Manager to activate an alarm. This subroutine will activate an alarm and signal it as unacknowledged.

Disable

Deprecated. (Alarm Manager module) Tell the Alarm Manager to disable an alarm. Disable will also clear any active or unacknowledged state that might exist.

Enable

Deprecated (Alarm Manager module) Tell the Alarm Manager to enable an alarm.

Event

Deprecated. (Alarm Manager module) Tell the Alarm Manager when an alarm event occurs. This subroutine will cause an entry to be added to the log file without changing the alarm status.

ListAdd

Deprecated. (Alarm Manager module) This subroutine will add the alarm object to a list. This is useful if a user-defined list has been created.

ListRemove

Deprecated. (Alarm Manager module) This subroutine will remove the alarm object from a list. This is useful if a user-defined list has been added.

Normal

Deprecated. (Alarm Manager module) Use this function to tell the Alarm Manager when an alarm clears. This subroutine will deactivate the alarm. It will not affect the unacknowledged status.

NormalTrip

Deprecated (Alarm Manager module) This subroutine will deactivate an alarm and signal it as unacknowledged.

OffNormal

Deprecated. (Alarm Manager module) This subroutine will activate the alarm. However, it will not affect the unacknowledged status.

Popup

Deprecated. (Alarm Manager module) Causes an alarm pop-up dialog to display.

Register (Alarm Manager)

Deprecated. (Alarm Manager module) Inform the Alarm Manager that a module instance may wish to generate alarms in the future.

SetEnable

Deprecated. (Alarm Manager module) Use in preference to Enable to enable or disable alarms build into tags.

TransferFields

Deprecated (Alarm Manager module) The TransferFields subroutine will transfer the values for each field into the returned FieldValues array. The values are found in the scope passed in using the variable names found in the FieldNames array.

Trip

Deprecated. (Alarm Manager module) Tell the Alarm Manager to when a trip alarm event occurs. This subroutine will signal an alarm as unacknowledged.

Unregister (Alarm Manager)

Deprecated. (Alarm Manager module) Notify the Alarm Manager that an alarm has been removed. This will not generate an alarm, it just removes it from the list of all configured alarms.
AdjustArray Changes the array information for a variable.
AMax Array maximum. This function returns the maximum value in a sub-range of a numeric array.
AMin Array minimum. This function returns the minimum value in a sub-range of a numeric array.
ArrayDimensions Returns the number of dimensions in an array.
ArrayOp1 Performs a mathematical operation on an array with respect to a scalar value.
ArrayOp2 Performs a mathematical operation on an array with respect to another array.
ArraySize Returns the number of elements in an array dimension.
ArrayStart Returns the first element in an array dimension
ArrayToBuff Returns a buffer containing the numeric data from an array.
ArrayToDictionary Returns a dictionary if given an array of key names and a matching array of values.
AValid Returns the number of valid elements in an array sub-range.
BuffToArray Reads an array from a formatted buffer containing numerical data and returns the number of elements read.
BuffToPointer Converts a buffer of numeric data to array of pointers. This function reads from a formatted buffer containing numeric data, writes to locations specified by an array of pointers, and returns the number of elements read.
Compress Eliminate invalid array entries.
DeleteArrayItem Deletes an element from a single dimension dynamically allocated array and returns the modified array.
Filter Sets the value of one array element to invalid if the corresponding value in another array element is invalid.
FiltHigh Sets the values in an array sub-range that fall above a specified upper limit to a new value.
FiltLow Sets the values in an array sub-range that fall below a specified lower limit to a new value.
GenerateQRCode Returns a 2D array which represents a QR code for a given string.
InsertArrayItem Insert Array Item. This function inserts an element into a dynamically allocated array and returns the modified array.
LookUp Looks up a value in an array and returns the index of the element containing that value.
MakeArray Create and initialize an array in one line of code.
Mean Returns the mean (average) of a portion of a numerical array.
New Allocates memory for an array from RAM and returns a pointer to that array.
PointerToBuff Returns a buffer containing the numeric data from the variables pointed at by each element of the array.
ReadX Reads numeric data from a text file into the elements of an array.
ReadXY Reads data points from a file into the elements of two arrays.
SDev Returns the statistical sample standard deviation for a subsection of an array.
Sort Allows the sorting of an array subsection according to the order of another array.
SortArray Sorts an array of arrays based upon the key information provided by the second parameter.
Sum Returns the arithmetic sum of all the valid array elements in a specified portion of a numeric array.
TextSearch Returns the array index of the first occurrence of the given text key in an alphabetically ordered array.
Unpack Unpacks a set of values from a stream into a single dimensional array or a set of variables referenced by object parameters, and returns the number of items unpacked.
UnpackData (RPC Manager Library) This method unpacks a stream into an array or set of module instance parameters. Subroutine call only.
Variance Returns the statistical sample variance for a subsection of an array.
WatchArray Watches an array and returns true if any of its elements types or values change.
And Returns the bit-wise AND of its two parameters as a 32-bit unsigned integer.
Bit Returns the on/off status of a bit in a number.
Not Returns the result of a 32 bit unsigned bitwise logical NOT operation.
Ones Returns the number of bits set in an integer number.
Or Performs a bit-wise OR operation and returns the result.
SetBit Sets or clears a specific bit in a value and returns the result.
XOr Returns the bitwise exclusive OR of its parameters.
Bubble Starts a new child bubble and launches the given module into a new script thread in that bubble.
BubbleList Lists the running child bubbles of the current bubble.
BubbleQueueLength Reports the length of the queue of messages from the current bubble's parent bubble or one of its children.
BubbleReceive Receives a message from the given bubble.
BubbleSend Sends a message to the given bubble.
ProcessingLoad Returns the current VTScada processing load of the calling bubble.
RunInBubble Starts a new thread in the given child bubble and launches the given module into that script thread.
Thread Launches a module in its own separate thread.
ThreadHistory Returns in an array, the history of execution for all threads.
ThreadIdle Returns TRUE when the ToDo list for a given thread is empty.
ThreadList Returns a two dimensional array containing the name and statement last executed by each VTScada thread.
ThreadName Returns the name of a thread.
ThreadPriority Allows advanced users to set a specified thread to one of six priorities, ranging from idle to time critical.
TODBC Performs an ODBC command.
TODBCBeginTrans Indicates to an ODBC-compliant database that a transaction is to be started.
TODBCCommit Indicates to an ODBC-compliant database that a transaction is to be committed
TODBCConnect Forms a connection to an ODBC database.
TODBCDisconnect Stops a connection to the ODBC database.
TODBCRollback Indicates to an ODBC-compliant database that a transaction is to be discarded.
AddCertificate Returns a structure of information about a supplied X.509 certificate.
CheckCertificateChain Checks the chain of trust of a certificate
FindCertificate Locates a certificate in a certificate store.
GetCertificateInfo Returns a structure of information about a supplied X.509 certificate.
ListCertificates Enumerates X.509 certificates in a certificate store resident on the local computer.
MakeSelfSignedCertificate Creates a new self-signed certificate.
RemoveCertificate Removes a certificate from a certificate store.
SetCertificateProperty Sets a modifiable property on a stored certificate.
ClipboardGet Returns the current contents of the system clipboard as a string. This function enables an application to perform text "paste" operations.
ClipboardPut Set the current contents of the system clipboard to a string. This function enables an application to perform text "copy" or "cut" operations.
Blend Returns an aRGB color value that is a given percentage between two specified colors.
Brush Returns a brush value.
Cls Clears the screen and sets its background color.
ColorSelect (System Library) Color Selection Tool. This module draws a color selection button and its accompanying display area.
GetColorInfo Returns the brush and pen information for a given graphic statement.
GetEquipmentColor Returns a defined Equipment Color that was set in a style tag based on the equipment type of an IO tag
GetSystemColor Returns the colors for the user-configured Windows™ colors.
PalStatus Returns the current palette settings.
PColorSelect (VTS Library) Draws a button that opens a color selection dialog and an area that displays the currently selected color.
Pen Returns a pen value.
PixelColor Returns the color of a pixel in the window.
ZColorChange Changes one color within a region to another color.
ActiveX Instantiates an ActiveX object. An ActiveX object is treated as a COM client interface that requires a client window area in which to draw.
COMClient Instantiates COM objects that do not possess a user interface.
COMEvent Sets an event subroutine context for an existing COM client interface.
COMStatus Returns the last status information that occurred for a specified COM client interface.
ActiveCode ActiveCode returns the code value of the currently active statement in the given module instance.
ActiveState ActiveState returns the code value of the currently active state in the given module instance.
ActiveWindow ActiveWindow returns the object value of the root module instance in the current active window.
AddModule Adds a new module to an existing module and returns the value of the newly created module.
AddOptional Adds a new statement to an action script and returns its own error code.
AddPageToApp (Obsolete) Creates a new application page.
AddParameter Adds an existing variable as a module parameter and returns the number of parameters in the module.
AddState Adds a new state to an existing module and returns its state value.
AddStatement Adds a new statement to an existing state and returns its own error code.
AddVariable Adds a new variable to an existing module and returns its variable value.
AdjustArray Changes the array information for a variable.
AdjustCode Adjusts the offsets and sizes of items stored in the .RUN file within the document file.
BuffToParm Convert buffer of numeric data to parameters. This function reads module parameters from a formatted buffer containing numerical data and returns the number of data items read.
Call Starts an instance of the module specified by its first parameter.
CalledInstances Returns the object values of module instances that are called by a particular module.
Caller Takes a given object value for a module and returns the object value of the module by which it was called.
CanEditDoc Returns an indication as to whether the document for the given module can be edited.
Cast Takes a value and returns a different type of value, if possible.
ChildDocs Gets the module values for the root and all descendent modules that match the conditions defined by the second parameter.
ClearModule Deletes the contents (all variables and states) of a module without removing the module itself.
ClearState Deletes all of the statements in a state.
Compile Compiles text and creates a new function. The type of return value is determined by its input parameters.
ConstCount Returns the number of constant parameters in a function.
CreateModule Creates a new module and returns a pointer to it.
CriticalSection Marks a section of a module as a critical section and will not allow interruption of its execution by other threads.
Debugger (System Library) Starts the VTScada debugger.
DeleteModule Deletes a module from the system.
DeleteOptional Deletes a statement from an action script.
DeleteState Deletes a state from a module.
DeleteStatement Deletes a statement from a state.
DeleteVariable Deletes a variable from a module.
DelPageFromApp Deletes a system page from an application.
FileRootModule Parses the document file that contains the given module to find the root module in that file. Returns the module value of the root module.
FindAction Returns an action from the list of actions in a state.
FindVariable Searches for a variable by text name and returns a variable value.
FirstState Sets the first state in a module.
ForceState Sets the next state to start when the action script completes.
FormalParms Returns the number of formal parameters declared in a module.
GetDefaultValue Returns a variable's default value.
GetLiveMJPEG Configured within a camera tag module, returns a reference to the current frame retrieved from the IP camera.
GetID This returns the ID (opcode) of a given function.
GetInstance Returns the object value of a module instance.
GetModuleRefBox Get Module Reference Box
GetModuleText Returns information about a module's document file.
GetOneParmText Returns the text for one parameter of a function.
GetOverrides Returns an array of OpCodes and the module value that will run when each OpCode is executed
GetParmText Returns the text for all parameters of a function.
GetParserOffset Returns the offset before the last compiled statement.
GetReturnValue Returns a module's return value.
GetState Returns the code value for the specified state.
GetStatement Returns the code value for the specified statement.
GetStatementNum Returns the statement number for the specified statement.
GetStateText Returns the text for the specified state.
GetToken Reads the next token from a stream and returns the token type.
GetTransitText Get Transition Document Text. This function returns information about the documentation of an action.
GetVariableText Returns information about the documentation of a variable.
GetXformRefBox Get Transform Reference Box. This function returns the reference box for any transform of a module.
LastSelected Returns the most recently selected graphics statement.
ListVars Returns a list of variables.
LoadDLL Loads a Microsoft Windows™ dynamic link library.
LoadModule Loads a module from its .RUN files and returns a pointer to that module.
LValue Left-hand Side Value. This function returns an indication of whether its argument can be used on the left-hand side of an assignment.
MakeDAG Constructs a Directed Acyclic Graph (DAG - an internal function representation).
MakeNonPersistent Takes a variable and makes it not persistent.
MakeNonShared Takes a shared variable and makes it not shared.
MakePersistent Takes a variable and makes it persistent (static).
MakeShared Takes a variable and makes it shared.
MCSInstance Module Calling Structure Instance. This function returns the object value of a module called by another module.
MCSMod Module Calling Structure Module. This function returns the module value from a line of code that calls that particular module.
ModuleFileName Returns the full path (including the drive letter) and file name of the document (.SRC) file of a module.
NParm Returns the number of parameters listed in a module instance.
NumParms Returns the number of parameters of a statement.
NumSets Returns the number of statements that are currently active in setting a particular variable.
NumVariables Returns the number of variables in a module.
OwningModule Returns the module which contains a certain variable.
ParserSRO Adds a scope resolution reference to a variable on the top of the PARSER_STACK given the stack and the object variable.
PersistentSize Returns the size in bytes of a variable's persistent value size in the persistent value (.VAL) file.
RemoveParameter Removes a parameter from a module's parameter list.
ReplaceStatement Replaces a statement with another statement.
ResetParm Can reset parameters that become latched.
ResyncDoc Synchronizes the time and date for the document and .RUN files.
RUNFileName Returns the name of the .RUN file for a module including the full drive and path.
RUNFileVersion Returns the minimum version of VTScada that can read the .RUN files produced by the current version.
SaveModule Saves a module definition to its *.RUN file.
SetDefault Sets the default value for a variable.
SetModuleRefBox Sets the reference box for a single instance of a module.
SetLibrary Sets the library for an application.
SetModuleRefBox Sets the default reference box for a module.
SetModuleText Sets the module's .SRC file information.
SetOneParmText Sets the text for one parameter of a function.
SetParameter Sets a parameter in a statement.
SetParmText Sets the text for the parameters of a function.
SetParserParm Sets the value for the last parameter on the parser stack and returns its own error code.
SetRefRect Sets the first four constant parameters of a layered graphic statement.
SetStateText Sets the information about the text of a state in a .SRC file.
SetTransfer Sets the destination for an action.
SetTransitText Sets the information about the documentation of an action in the .SRC file.
SetVariableClass Sets the class number of a variable and returns its previous class number.
SetVariableText Sets the information about the documentation of a variable in the .SRC file.
SetVariableType Sets the data type for the variable, so that only values of that data type can be stored in the variable.
StateList Returns a list of states for a module.
StatementInstance Takes a given code value and object and returns a code pointer value for that instance.
StateName Returns the text name of the given state.
SubStatementIndex Returns the index of a function within the statement where it is called.
VarAttributes Returns the attributes bit field of a variable.
NewTagsFullyStarted Returns TRUE if all new tags have started, run their Refresh modules, and started any children.
ModifyTags Can be used to create, modify, or delete running tags. Replacement for StartTag.
OpChange Wrapper for TagMigrator\OpChange. Performs an immediate deploy of a single tag change without disturbing any other tag changes already in place on the local branch.
SimpleOpChange Immediately deploys a single parameter change on a single tag without disturbing any other tag. Makes use of OpChange.
StartTag (Deprecated. See: ModifyTags) Is used to create tags by starting new instances of the tag type specified in the parameter list. When creating an application that requires child tags, it is recommended that this function be used in place of the older ChildLaunch function.
AcquireLock Subroutine to acquire an exclusive lock on reading/writing working copy files across all applications.
AppIsRunning Reports whether the application has been started and the start-up process is complete.
AppIsStarted Returns TRUE if the application has been started.
AppIsStarting Returns TRUE if the application is currently in the process of starting.
ApplyChangeSetFile Apply a named ChangeSet to an application layer.
CaptureSettings Gathers a single property value or an accumulated section and returns the result in a tabular format.
Combine Performs a Merge2 operation with automated conflict resolution and change priority.
CommitEditedFiles This function compiles and commits edited files if the compile succeeds.
DirectApply Applies a set of changes directly to the repository, without disturbing existing (non-conflicting) changes already on either branch.
EditFile Informs the configuration management system that a file has been modified in the working copy, typically before making a call to CommitEditedFiles.
GetAppInstance Asynchronously, retrieves the Layer object (LayerRoot) for a particular application specified by its GUID.
GetCodeObj Retrieves the "Code" object associated with the layer.
GetCurrentSubordinate Retrieves the current subordinate driver value of the Driver Multiplexer tag.
GetINIProperty Given an array of INIProperty structures, returns the value of a given property from that array.
GetLoadedAppInstance Synchronously, retrieves the Layer object (LayerRoot) for a particular application specified by its GUID.
GetOEMLayer Retrieves the layer root module of the OEM layer (should one exist) of the layer this is called against.
GetPlatformInfo Gathers information about the current application and the workstation it is running on.
GetSubordinateDriver Returns the subordinate driver object of the Driver Multiplexer tag based on the input parameter.
GetWCPath Returns the full working copy path for an application.
GetWCRevision Returns the revision structure for the repository revision currently in use by the working copy.
HasCompilationErrors Reports if the working copy presently has unresolved compilation errors
HasUndeployedChanges Finds whether the local machine is maintaining changes that have not been deployed, including changes that have been recorded by EditFile but have yet to be committed.
IsAppEditable Returns TRUE if the application can currently accept changes without being re-started.
IsOnLocalBranch Returns TRUE if the local machine is maintaining changes that have not been deployed within the repository.
IsRunOnly Returns TRUE if the application is a run-file-only app, according to the WC contents.
LayerInUse Returns true if the application is running, or if there are any applications that depend on this layer, running or not.
Merge Applies a set of changes (the output of a Diff operation) to a buffer.
Merge2 Attempts to apply two different Diff buffers to a single origin buffer.
ReadINIProperties Gathers the sum of all of the properties files in this layer and all of its parents including the local workstation files.
ReleaseLock Releases a working copy semaphore that was acquired by AcquireLock.
ReadPropertiesFile Reads a single Settings file and returns an INIFile Structure.
RecordProperty Helper function used to record settings without needing to explicitly interact with the settings files.
RepoSubscribe Allows the caller to specify a callback which will be triggered whenever the application’s repository changes.
SetINIProperty Given an INIFiles structure, this function sets the property with the specified name and section to the specified value
Start Start an application.
LayerRoot\Stop Stop an application.
WriteINIProperties The opposite to ReadINIProperties.
WritePropertiesFile Write a single Settings file according to the properties in an INIFile structure.
AddContributor Adds a contributor to a container.
DeleteContributor Removes a contributor from a container.
GetContributors Returns a copy of an array of object values of contributors for a given container.
PContributor (VTS Library) Draws a splitlist displaying all contributors to a specific tag.
Base64Decode Performs a Base64 decode of a buffer. If the two optional parameters are not supplied, this function simply calls Base64Decoder.
Base64Decoder Performs a Base64 decode of a buffer.
Base64Encode Wrapper for Base64Encoder
Base64Encoder Performs a Base64 encode of a buffer
CheckSignature Checks a digital signature with a key given a handle returned from Hash().
CryptRandom Returns a buffer of random byte values.
Decode Returns the plain value of a cipher that is the result of the Encode function.
Decrypt The Decrypt function decrypts data previously encrypted using the Encrypt function. It is the VTScada analog of the CryptoAPI CryptDecrypt call.
DeriveKey Generates a cryptographic session key from a seed value.
Encode Processes a VTScada string using a configurable selection of compression, encryption, encoding and secure hashing.
Encrypt The Encrypt function encrypts data. The algorithm used to encrypt the data is designated by the Key parameter. It is the VTScada analog of the CryptoAPI CryptEncrypt call.
ExportKey The ExportKey function exports a cryptographic key or a key pair from a CSP in a secure manner as a Key BLOB. It is the VTScada analog of the Crypto API ExportKey call.
GenerateHMAC Calculates the hash-based message authentication code (HMAC) for a given key and input message.
GenerateKey The GenerateKey function generates a random cryptographic session key or a public/private key pair. A handle to the key or key pair is returned. This handle can then be used as needed with any CryptoAPI function requiring a key handle. It is the VTScada analog of the CryptoAPI’s CryptGenKey call.
GenerateSignature Generates a digital signature of a handle returned from Hash().
GetCryptoProvider The GetCryptoProvider function is used to acquire a handle to a particular key container within a particular cryptographic service provider (CSP). This returned handle can then be used to make calls to the selected CSP. It is the VTScada analog of the CryptoAPI CryptAcquireContext call.
GetKeyParam The CryptGetKeyParam function retrieves data that governs the operations of a key. It is the VTScada analog of the CryptoAPI’s CryptGetKeyParam call.
Hash Generates a hash - a text string of bytes - of the given string.
ImportKey The ImportKey function transfers a cryptographic key from a key BLOB into a CSP (cryptography service provider). It is the VTScada analog of the CryptoAPI’s ImportKey call.
SetKeyParam The SetKeyParam function customizes various aspects of a session key's operations. The values set by this function are not persisted to memory and can only be used with in a single session. It is the VTScada analog of the CryptoAPI SetKeyParam call.
DBAdd Executes in its own thread to add a record to a VTScada database and returns an indication of parameter errors.
DBGetStream Executes in its own thread to convert a database to a stream, and returns an indication of parameter errors.
DBInsert Identical to DBAdd, except will not update existing records.
DBListGet Executes in its own thread to retrieve certain records from a list in a VTScada database and returns an indication of parameter errors.
DBListSize Executes in its own thread to retrieve the size of a certain list in a VTScada database and returns an indication of parameter errors.
DBRemove Executes in its own thread to remove a record from a VTScada database and returns an indication of parameter errors.
DBSystem Creates a VTScada database and returns its value. The maximum field length is 65,523 characters. If the field length is longer than 65,523 characters, the DBSystem call will return invalid.
DBTransaction Executes in its own thread to perform a transaction on a VTScada database and returns an indication of parameter errors.
DBUpdate Executes in its own thread to update a VTScada database from a given stream and returns an indication of parameter errors.
DBValue Returns a certain value retrieved from a VTScada database.
ODBC Performs an ODBC command and returns a (dynamically allocated) array if required.
ODBCBeginTrans Indicates to a specified ODBC-compliant database that a transaction is to be started.
ODBCColumns Returns a dictionary of column names grouped by the tables that contain them.
ODBCCommit Indicates to a specified ODBC-compliant database that a transaction is to be committed.
ODBCConfigureData Configures an ODBC data source and returns its error code.
ODBCConnect Forms a connection to an ODBC-compliant database and returns the ODBC value associated with that database.
ODBCDisconnect Stops a connection to the ODBC database.
ODBCRollback Indicates to a specified ODBC-compliant database that a transaction is to be rolled back (discarded).
ODBCSources Retrieves a list of ODBC data sources and returns it as a (dynamically allocated) array.
ODBCStatus Returns the requested information about the last ODBC statement to execute.
ODBCTables Retrieves a list of the tables present in an ODBC-compliant database and returns it as a dynamically allocated array.
RegisterCustomTable Registers a name for a virtual database table and defines what information will be available from that table.
SQLQuery A launched module that executes an SQL query on data in a VTScada application.
TODBC Performs an ODBC command. Similar to ODBC except that it runs in its own thread.
TODBCBeginTrans Indicates to an ODBC-compliant database that a transaction is to be started. TODBCBeginTrans is similar to ODBCBeginTrans, except that it runs in its own thread.
TODBCCommit Indicates to an ODBC-compliant database that a transaction is to be committed. TODBCCommit is similar to ODBCCommit, except that it runs in its own thread.
TODBCConnect Forms a connection to an ODBC database. Similar to ODBCConnect except that it runs in its own thread (see "Comments" section for differences)
TODBCDisconnect Stops a connection to the ODBC database. Similar to ODBCDisconnect except that it runs in its own thread (see "Comments" section for differences).
TODBCRollback Indicates to an ODBC-compliant database that a transaction is to be discarded. TODBCRollback is similar to ODBCRollback, except that it runs in its own thread.
TServerList Executes in its own thread and creates a pointer to an array of all servers visible from this workstation. Returns a flag indicating its status upon completion.
DDE Returns the value of the data for a specific item from a DDE server program. This function is a DDE client.
DDEPoke Sends a value for a specific item to a DDE server program.
DDEShareAdd Adds a new DDE share name to the SYSTEM.INI file or the registry and returns its own error code.
DDEShareDel Deletes a DDE share name from the SYSTEM.ini file or the registry and returns its own error code.
SetDDEServer Sets the DDE topic name for a window.
ArrayToDictionary Returns a dictionary if given an array of key names and a matching array of values.
ClearVarMetaData The opposite of SetVarMetaData, this statement removes all metadata associated with a variable.
Dictionary Creates a database-like storage structure that provides efficient addition, retrieval and removal of information linked to key values.
DictionaryCopy Create a new dictionary with contents identical to an existing dictionary. It is expected that this function will be used rarely, since in most cases it will be more efficient to hand off a reference to a dictionary rather than build a duplicate of it.
DictionaryRemove Removes a key / value pair from a dictionary, providing a means to regain memory space and remove data that is no longer needed.
GetKeyCount Return a count of the number of keys stored by the given dictionary.
GetNextKey Allows a linear search through a dictionary in place. i.e. without copying the contents to an array.
GetVarMetadata Every variable object contains an embedded value. This function is used to retrieve those values.
HasMetaData Tests whether a given variable is a dictionary. Because the default behavior of most operands and functions on dictionaries is to return just the value of the dictionary’s root, this function provides the only means to determine whether a variable contains a dictionary.
IsDictionary A synonym for HasMetadata. Tests whether the parameter is a dictionary.
ListKeys Returns an array of all keys used within a dictionary. It is expected that this function will be used primarily in the context of metadata (extended information attached to a variable). ListKeys also enables you to discover what is in a dictionary.
MakeDictionary Create and initialize a dictionary with one line of code
MetaData If used with a variable which is not currently a dictionary, this command attached meta data to that variable, thereby creating a dictionary object. The primary purpose in this case is to provide a means of associating extended data with a variable.
RootValue Retrieves the root value from a dictionary. This function will always attempt to return a value that is not itself a dictionary. If the value stored as the root of the given dictionary is also a dictionary, this function will return the root value from that second dictionary. Should all root values be other dictionaries (which would imply that the dictionary at the end of the chain must actually be an earlier dictionary) then RootValue will traverse the chain until it finds a root value which is an earlier dictionary (i.e. the end of the chain before it loops back) and will return that root value. This is the only situation where the command will return a dictionary as the result.
SetVarMetadata Every variable object contains an embedded value. This function is used to set those values.
DLL Returns a value of a type specified by its parameter from a call to Microsoft Windows™ dynamic link library using the C calling convention.
LoadDLL Loads a Microsoft Windows™ dynamic link library.
AddEditorText Inserts a text string into a text editor.
CurrentLine Deprecated. Returns the text string that is the current line in an editor.
Editor Deprecated. Displays an editor on the screen.
ForceEvent Deprecated. Forces the editor to perform an action based on the information provided.
GoToOffset Deprecated. Forces an editor to move to a location in its text.
MakeEditor Returns an editor value which is used by an editor
MoveEditor Deprecated. Moves the Editor to the given line and column.
SetEditMode Sets the graphics edit mode for a window.
ZEditField Draws a layered text edit field in a window and returns a status value.
SendMail Sends a string to an email server using the Simple Mail Transport Protocol (SMTP)
ValidateEmailAddrs This subroutine validates a string of email addresses, and returns TRUE if the email addresses in the string are syntactically valid, or FALSE if they are not.
ReportError Post error information to VTS Trace and optionally, to the display.
   
CheckFileExist (System Library) This subroutine checks for the existence of the specified file.
CheckPathExist (System Library) This subroutine checks for the existence of the specified path.
CopyDir (System Library) This subroutine recursively copies a directory's files and sub-directories down through the entire directory tree.
Dir Performs a search in the given directory and returns an array of matching file names.
FileChooser Provides an edit box for specifying a file name, along with a label and a browse button.
FileDialogBox Displays a threaded system common file dialog box.
FileFind Performs a recursive search down through the directory tree structure and returns an array of matching file names.
FileRootModule Parses the document file that contains the given module to find the root module in that file. Returns the module value of the root module.
FileSize Returns the size of a disk file in bytes.
FileStream Returns a stream attached to a disk file or printer, and is suitable for use in SWrite.
FindFile  
FRead Reads values from a formatted file and returns the number not read.
FWrite Writes ASCII or binary data to a file and may also be used to create or delete a file. It returns the number of data items not written.
Get Deprecated. Reads an array of historical data from a file (written by Save or SaveHistory) and returns the relative file position of the file entry following the last one read, or an error code.
GetFileAttribs Returns information about the specified file.
GetHistory Deprecated. Get History from a File written by Save or SaveHistory. This threaded function retrieves an array of data from a .DAT file for a certain time span. If the parameters to GetHistory are valid and an attempt is made to get the data, the return value is 0, otherwise, if no attempt is made to get the data, the return value is 1.
GetLog This launched module returns an array of logged data. Marked for removal, but still in use as of VTScada 12.2. Use GetTagHistory instead for all new code.
GetLogInfo Deprecated. Interrogates a historical data file, or a set of historical data files, and returns overall time, date, and record count information either for the entire file(set), or for a specified time range.
LoadMIB Loads a specified MIB or set of MIBs and returns a dictionary describing the hierarchy of the MIBs.
MkDir Creates a directory on a disk and returns its own error code
ModifyConfiguration Provides a safe way to write to configuration files.
ModuleFileName Returns the full path (including the drive letter) and file name of the document (.SRC) file of a module.
ReadConfiguration This function provides a safe way to read configuration files.
ReadINI This subroutine read a variable entry from a Settings file or a buffer containing one and returns its value.
ReadSectINI This subroutine read an entire section entry from a Settings file or a buffer containing one and returns a 2-dimensional array containing variable names and their values.
ReadX Reads numeric data from a text file into the elements of an array.
ReadXY Reads data points from a file into the elements of two arrays.
Rename Renames an existing file.
ResyncDoc Synchronizes the time and date for the document and .RUN files.
RmDir Destroys a directory on a disk and returns its own error code.
RUNFileName Returns the name of the .RUN file for a module including the full drive and path.
RUNFileVersion Returns the minimum version of VTScada that can read the .RUN files produced by the current version.
Save Deprecated. This threaded function stores data in a circular historical data file at times indicated by a condition and returns the record number last written to disk.
SaveFile Helper function to save files or streams on a server, VIC or Anywhere Client.
SaveHistory Deprecated. This threaded function saves an array of data to a .DAT file for a certain time span.
SetCodeText Will modify a source code file to replace the text for a given CodeValue with the new text.
SetFileAttribs Sets the attributes of the specified file.
SpeakToFile Executes on the speech thread to speak the supplied text to a .wav format audio file.
SplitPath Breaks up a file path name into its components.
TempFileStream Uses the OS tmpfile() function to create a temporary file on disk and to connect a stream to the temporary file. The temporary file is removed when the stream is closed or no longer referenced or if the VTScada process is terminated.
TGet Deprecated. This threaded function reads an array of historical data from a file (written by Save or SaveHistory) and returns an indication of parameter errors.
WriteHistory (Historian Manager Library) This subroutine writes a variable's value to a Settings file or a buffer containing one and returns its error code.
WriteSectINI (System Library) This subroutine writes an entire section to a Settings file or a buffer containing one and returns its error code.
XMLWrite Converts the instance of a type, as specified by XMLNodeTreeIn, into XML.
BinaryToIP Converts an IP address from binary notation to decimal.
DetectFlatline Returns TRUE if the monitored value stays the same for a specified length of time.
FormatInteger Given a numeric value, returns that value converted to Hex, Octal or Binary as specified.
GetDisplayValue  
GetEquipmentColor Returns a defined Equipment Color that was set in a style tag based on the equipment type of an I/O tag.
GetEquipmentLabel Returns a defined Equipment Label that was set in a style tag based on the equipment type of an I/O tag.
GetPhrase Returns the key matching a given phrase.
MakeParmPhrase Returns a \ParmPhrase structure given a phrase key and parameters.
OilVolumeCorrectionFactor Returns a coefficient to adjust a volume of oil to different temperature and pressure conditions.
OilVolumeCorrectionToBase Wrapper for OilVolumeCorrectionFactor, used to determine the volume correction factor for shifting a fluid at alternate conditions to standard conditions (60°F, 0 psig).
ShellTemperatureCorrection Returns a coefficient to adjust the calculation of volume within a tank.
TableInterpolation Given a graph described by a CSV file containing X and Y values, this function will interpolate a Y value for any provided X value within the range of the graph.
TrimSpaces Returns text with leading and trailing spaces removed.
4BtnDialog (System Library) Draws a message dialog with up to 4 buttons and 3 lines of text and returns the number of the button that was pressed.
AlignSelected Deprecated. Aligns selected graphic objects.
Bevel (System Library) Draws a titled beveled box.
BitmapInfo Returns information about an image.
Brush Returns a brush value.
CaptureImage Creates an image handle from a GUIStretch operation
CheckBox (System Library) Draws a check box with (optional) label.
Click Returns an indication of whether the mouse pointer is within a specified screen area and a particular button combination is being pressed.
ClosePopUp  
ColorSelect (System Library) Color Selection Tool. This module draws a color selection button and its accompanying display area.
CommitFocused This function causes any edit field, while being edited, to output the value currently found in that field.
Coordinates Deprecated. Sets the VTScada screen coordinate limits (also called "world coordinates") used by the graphics functions.
CoordToPixel Takes a specified coordinate pair within a given window and returns the overall, onscreen pixel location.
Crop Modifies an existing image, producing a new one that displays a sub-section of the original.
DateSelector Displays a calendar, from which operators can select a date.
DecodeParms Takes a string of page parameters for a MenuItem tag and returns the values assigned for those parameters.
DialogInitPos (System Library) Attempts to position a dialog so that it is not started beyond the left, right, top, or bottom of the visible screen.
DragHandle Drags a selected graphic object's selected handle.
DrawArcPath Draws an arc in any window.
DrawChordPath Draws a chord in any window.
DrawEllipticalPath Draw an ellipse in any window.
DrawPath Draws a polygon in any window.
DrawPiePath Draws a pie in any window.
DrawQRCode Draw a QRCode at a given location.
DrawScale (Meter Parts Library) Will draw a scale (i.e. tick marks) for a linear or radial type meter. These marks are images (normally lines) indicating the major and minor divisions of the entire scale. This function must be called inside a GUITransform to work properly.
DropList (System Library) Draws a droplist with (optional) title or bevel or both.
Edit (System Library) Draws an edit field with (optional) title or bevel or both.
EditINI (VTS Library) Draws an edit field from which a value of an application property in Settings.Startup may be set.
EditINICheckBox (VTS Library) Draws a check box with which an application property in Settings.Startup may be set true or false.
Editor Displays an editor on the screen.
FileDialogBox Displays a threaded system common file dialog box.
FocusID Returns the focus ID of the object in a window that currently has the input focus.
Folder (System Library) Draws a tabbed folder dialog.
Font Returns a font value.
FontDialog Displays a threaded system common font dialog box.
GetColorInfo Returns the brush and pen information for a given graphic statement.
GetDisplayIndex Returns the index of the caller's display instance.
GetDisplayRoot Climbs the call tree looking for the best display context.
GetModuleRefBox Get Module Reference Box
GetPathBound Returns the bounding box coordinates for a path.
GetSelected Returns a selected graphic item in a window.
GetSelectedInfo Returns information about selected graphic item(s) in a window.
GetShapePath Returns the path value which defines the shape of a polygon.
GetSystemColor Returns the colors for the user-configured Windows colors.
GetTrajectoryPath Returns the Path value which defines the trajectory of a graphic object.
GetTransform Returns the transform value applied to a graphic statement.
GetXformRefBox Get Transform Reference Box. This function returns the reference box for any transform of a module.
Grid Places a (lined) grid pattern on the screen.
GridList (System Library) Draws a list in the style of a spreadsheet.
GUIArc Draws an arc in a window and returns an indication when selected by a mouse button or the <ENTER> key.
GUIBitmap Draws an image of any of the following formats in a window and returns an indication when selected by a mouse button or the <ENTER> key. Available formats include: BMP, EMF, WMF, APM, CUT, PCX, JPG, PNG, and TIF
GUIButton Draws a push-button in a window and returns an indication when selected by a mouse button or the <ENTER> key.
GUIChord Draws a chord in a window and returns an indication when selected by a mouse button or the <ENTER> key.
GUIEllipse Draws an ellipse in a window and returns an indication when selected by a mouse button or the <ENTER> key.
GUIPie Draws a pie-shaped wedge in a window and returns an indication when selected by a mouse button or the <ENTER> key.
GUIPipe Deprecated. Use PathDraw. Draws a 3 dimensional, shaded pipe in a window and returns an indication when selected by a mouse button or the <ENTER> key.
GUIPolygon Draws a multi-sided polygon in a window and returns an indication when selected by a mouse button or the <ENTER> key.
GUIRectangle Draws a rectangle in a window and returns an indication when selected by a mouse button or the <ENTER> key.
GUIText Draws formatted text in a window and returns an indication when selected by a mouse button or the <ENTER> key.
GUITransform Applies a graphical transformation to all graphics in a module and returns an indication when selected by a mouse button or the <ENTER> key.
HScrollbar (System Library) Draws a horizontal scrollbar and returns its position.
HoursEntry Displays a time editing field.
IconMarker Deprecated. Creates the question mark and exclamation mark graphics, used to indicate questionable and manual data in a widget.
ImageArray Reads an existing image handle and returns another one containing an image created from that handle by tiling the image a given number of times.
ImageParmSet Returns a structure of image attributes that can be passed to an image-based widget.
ImageSweep Reads an existing image handle and returns another one containing an image created from that handle by tiling the image a given number of times along an arc-shaped path.
IPAddressList Displays a list of IP address which can be added to or removed from.
LastSelected Returns the most recently selected graphics statement.
LinearIndicator (Meter Parts Library) Will draw a linear type indicator. A linear indicator can be drawn in 3 different ways: Scaled from min to current position, cropped from min to current position or as a line that moves to the current position. This function must be called inside a GUITransform to work properly.
LinearLegend (Meter Parts Library) Draws a legend (i.e. the text labels) for a linear type meter. They are drawn in a line, either horizontally or vertically, with consistent spacing. This function must be called inside a GUITransform to work properly.
Listbox (System Library) Draws a listbox with scrollbar (if required) and indicates the selected item.
MakeBitmap Loads an image file of types BMP, EMF, WMF, APM, CUT, PCX, JPG, PNG, or TIF into memory and returns a handle to the result. Returns Invalid upon failure.
MapDraw Draws a "slippy" map, showing a list of site tags as pins on that map.
ModifyBitmap Reads an existing image handle and produces a new one with modifications. The original image is not altered. Returns invalid upon failure.
ModuleSnapshot Launched module that draws a module as an image.
MoveWindow Will move a window to the specified coordinates.
NextFocusID Moves the focus position to a specific ID number.
Normalize Returns a normalized value.
NumSelected Returns the number of selected graphics statements in a window.
Output Deprecated. Places formatted numbers or text on the screen.
PalStatus Returns the current palette settings.
ParentWindow Returns the object value of the nearest non-child window.
PasteObjects Pastes the code for multiple GUITransforms into a page source file.
Path Returns a graphics path value.
PathDraw Used within a Idea Studio handler to inform the engine that a path is being drawn, and to set the appearance of that path
Pen Returns a pen value.
Pending Returns the number of statements of a certain type pending.
Pick Returns an indication of whether the locator (e.g. mouse) has had a specified change in its button status.
Pipe Deprecated. Draw a Double Line
PixelColor Returns the color of a pixel in the window.
PhraseDroplist Language-sensitive droplist.
PhraseEdit Language-sensitive editfield. This module draws an editfield with (optional) title and bevel.
Plot Displays a plot of a subsection of a numeric array in a particular area of the window.
PlotBuff Displays a plot of a subsection of a buffer in a particular area of the window after converting the buffer to element values.
PlotXY Displays a plot of a curve in the window given the X and Y values in two arrays.
Point Returns a two-dimensional point, or location, in a window.
Popup (Alarm Manager module) Causes an alarm pop-up dialog to display.
PrintDialogBox Displays a threaded system common printer selection dialog box.
ProgressBar Displays a horizontal progress bar.
RadialIndicator (Meter Parts Library) Will draw a radial type indicator that sweeps from a minimum angle to a maximum angle in the same fashion that a real radial meter would.
RadialLegend (Meter Parts Library) Draws a legend (i.e. the text labels) for a radial type meter. They are drawn at a constant radius from the center point of the drawing coordinates, beginning at a defined minimum angle and ending at a defined maximum angle.
RadioButtons (System Library) Draws a set of labeled radio buttons with (optional) title and border.
RootTransform Returns the object value that contains the root transform applied to the given module.
Rotate Returns a Rotate value, which specifies a rotation about a point.
SaveImage Takes an image handle and saves it to an image file on disk.
SectionControl (System Library) Creates a control that displays a variable number of sections. Visually, a section consists of a header and content. The control manages the layout and geometry for the sections and runs a caller-supplied module to display the section content.
SelColor Sets a color value from a dialog
SelectArea Selects active graphics statements within a rectangular area in a window.
SelectCodePointer Given a window object and a code pointer for an active graphics object within that window, this function adds the graphics object to the window's selection set.
SelectDAG (i.e. Select Function) This function selects an active graphics DAG.
SelectGraphic Selects an active graphics statement at a location in a window.
SelectHandle Returns a pointer to a handle of selected graphics statements at a location in a window.
SelectHandleNum Selects the given handle of selected graphics statements in a window.
SelectPath Selects a path given its code pointer value.
SetCursor Sets the mouse cursor type for the window.
SetHandle Sets the position of graphics handles in a window.
SetModuleRefBox Sets the reference box for a single instance of a module.
SetModuleRefBox Sets the default reference box for a module.
SetRefRect Sets the first four constant parameters of a layered graphic statement.
SetXLoc Sets the X screen location of the locator (mouse).
SetYLoc Sets the Y screen location of the locator (mouse).
ShowPage When called with a Page Name, will cause that page to display in the caller's display session context
SimulateMouse Sets the pointer location and sends a button press with modifiers such as Ctrl, Shift or Alt. (mouse)
SpinBox (System Library) Draws a spinbox with (optional) label.
SplitList (System Library) Draws a split list (listbox with two columns) with a scrollbar if required and indicates the selected item.
SplitListSelector (System Library) Draws a split view comprising two GridLists separated by control buttons. Items listed on the left may be selected to be transferred to the right. Items on the right may be returned to the left so long as they were originally listed on the left. Scrollbars will be drawn if required.
SplitTagSelector Draws a split view comprising two GridLists separated by control buttons. Tag names listed on the left may be selected to be transferred to the right. Each GridList will have two columns: the name and the description of each tag in the list. Scrollbars will be drawn if required.
StopPage Subroutine to close all instances of a page.
Tag Returns a Tag value, which works like (and in place of) a Normalize value.
TagIconMarker Draws an "IconMarker" in the center of its transform area, and optionally shows a blank icon when in editing mode.
TextAttribs Returns graphic-related information about a text, given a font.
TextBox (System Library) Displays a text string, breaking it into multiple lines at space or CRLF.
ToolBar (System Library) Draws and maintains a toolbar and its buttons.
Trajectory Move a Layered Graphic and return a Trajectory value.
TreeControl Implements a tree control similar to that used by the Microsoft Windows Explorer folder panel.
UnselectGraphics Will deselect all of the graphics in the specified window.
UnselectObject Will deselect a statement in the context supplied.
UnTransform Will undo a previous transform so that the module instance and everything it has called will not be transformed.
UpdateCoordinates Will update a graphic statement's coordinates to the document file in which it is specified.
Vertex Returns a Vertex value, which is a collection of 3 points and a mode.
VScrollbar (System Library) Draws a vertical scrollbar and returns its position.
WebBrowser Displays a web browser at the given position in the current VTScada window
WebBrowserNavigate Call this to cause a WebBrowser to change pages.
WinButton Windows native button.
WinComboCtrl Windows native "combo" control. A "combo" control is an enhanced form of drop list. Displays a child window containing a Windows combo control.
WinEditCtrl Windows native edit control. This function returns a value indicating the status of an edit field.
WinTooltipCtrl Windows native "tooltip" control. A "tooltip" is a pop-up text window that provides operational hints to users when the mouse pointer is rested over a tool or object.
WinYLoc Returns the Y coordinate of the locator (mouse) in a window.
XLoc Returns the X window coordinate of the locator (mouse).
YLoc Returns the Y window coordinate of the locator (mouse).
ZBar Draws a layered bar in a window.
ZBox Draws a layered box in a window.
ZButton Draws a layered button in a window and returns true when selected.
ZColorChange Changes one color within a region to another color.
ZEditField Deprecated. Draws a layered text edit field in a window and returns a status value.
ZGrid Draws a layered point grid in a window.
ZLine Draws a line between given x and y coordinates in a window.
ZPipe Deprecated. Draws a layered three-dimensional pipe in a window.
ZText Draws a layered text label in a window.

A special sub-set of the Graphics tools, these are used only in tag configuration panels. All are members of the dialog library.

PAddressEntry Used for Tag I/O address entry.
PAlmPriority Draws a droplist of the currently available alarm priorities with an optional title and bevel.
PAreaSelect Draws a droplist of area options with (optional) title and bevel.
PCheckBox Parameter Setting check box. This module draws a check box with (optional) label.
PColorEdit Wrapper module for the standard color editing parameters
PColorSelect Draws a button that opens a color selection dialog and an area that displays the currently selected color.
PContributor Draws a split list displaying all contributors to a specific tag.
PDroplist Parameter Setting Droplist. This module draws a droplist with (optional) title and bevel.
PEditField Parameter Setting Editfield. This module draws an editfield with (optional) title and bevel.
PEditName Tag name setting editfield. This module draws an editfield that is to be connected to the name of a tag. Should be used by all tag ConfigFolder modules for setting the name parameter.
PFileChooser Parameter setting file selection. Provides an edit box for specifying a file name, along with a label and a browse button.
PHSliderBar Connects a horizontal slider bar to a given parameter number.
PHueSelect Connects a hue selection tool to a given parameter number.
PImageSelect Connects an image selection tool to a given parameter number.
PIPAddressList Uses an IPAddressList to set a parameter with a semicolon-delimited IP address list.
PIPListenerGroup Draws a droplist of all available IP Listener Groups.
PMultiCheckBox Display the standard set of check boxes.
POverride Tool used to override non-standard ConfigFolder controls for child tags.
PPageSelect Draws a titled, beveled droplist of pages in the system.
PPhraseDroplist Handles the complexity of parameter expressions by switching between display of a PhraseDroplist and regular Droplist control as is done in PPhraseEdit.
PPhraseEdit Draws a language-sensitive editing field.
PRadioButtons Draws a set of labeled radio buttons with optional title and border.
PSecBit Draws a titled, [beveled] droplist of options for setting the security bit.
PSelectCertificate Draws a drop-down for selecting a certificate from a list of available certificates, fields for displaying basic certificate information, and a button for accessing the Certificate Management UI.
PSelectObject

Draws a beveled, titled box showing the currently selected tag, a button to modify the connection in the hierarchy, and a new tag creation button.
PServerListName Called graphic module that creates an editable droplist of Server List Names, available to the tag.
PSpinbox Parameter Setting Spinbox. This module draws a spinbox with (optional) label.
PTimeZone Parameter Setting Droplist. Tool used to display a list of timezones, as defined by the operating system.
PTypeToggle Parameter Setting Type Toggled Field. This module draws a beveled droplist or editfield with title that sets a tag or numeric value.
SiteDispParms Parameter setting tool for Site List display options.
While not part of the dialog library, and not starting with the letter "p", this is still classified as one of the PTools.
EnableHelp Enables you to enable or disable help file activation when the F1 key is pressed.
Help Calls Windows™ help.
SetHelp Sets the help file name and (optionally) the context identifier for the window containing the specified object.
FocusID Returns the focus ID of the object in a window that currently has the input focus.
KeyCount Returns the number of keys pressed since the state became active, either edited or non-edited.
KeyFake Places a string of characters in a window's keyboard buffer.
Keys Returns the most recently pressed keys from either the edited or non-edited keystrokes.
MatchKeys Returns true if the specified keyboard keys have been pressed in the sequence given.
NextFocusID Moves the focus position to a specific ID number.
WinMatchKeys Returns true if the specified keyboard keys have been pressed in the sequence given in another window.
WinShiftKeys Deprecated. Returns a value which contains the current status of the Shift, Control and Alt control keys.
Click Returns an indication of whether the mouse pointer is within a specified screen area and a particular button combination is being pressed.
CurrentWindow Returns the application window over which the mouse cursor currently rests.
LocCapture Capture Locator Input. This statement captures all subsequent input from the locator device and routes it to a specific window.
LocSwitch Returns the current status of the locator (mouse) buttons over the window which contains the LocSwitch statement.
Pick Returns an indication of whether the locator (e.g. mouse) has had a specified change in its button status.
SetCursor Sets the mouse cursor type for the window.
SetXLoc Sets the X screen location of the locator (mouse).
SetYLoc Sets the Y screen location of the locator (mouse).
Target Returns an indication of whether the locator (e.g. mouse) is within a specified screen area.
WinLocSwitch Returns the current status of the locator (mouse) buttons in a certain window and its ancestors.
WinTooltipCtrl Windows native "tooltip" control. A "tooltip" is a pop-up text window that provides operational hints to users when the mouse pointer is rested over a tool or object.
WinYLoc Returns the Y coordinate of the locator (mouse) in a window.
XLoc Returns the X window coordinate of the locator (mouse).
YLoc Returns the Y window coordinate of the locator (mouse).
AddNote Add a note to the notebook
Get Reads an array of historical data from a file (written by Save or SaveHistory) and returns the relative file position of the file entry following the last one read, or an error code.
GetHistory Get History from a File written by Save or SaveHistory. This threaded function retrieves an array of data from a .DAT file for a certain time span. If the parameters to GetHistory are valid and an attempt is made to get the data, the return value is 0, otherwise, if no attempt is made to get the data, the return value is 1.
GetLog This launched module returns an array of logged data. Marked for removal, but still in use as of VTScada 12.2. Use GetTagHistory instead for all new code.
GetLogInfo Interrogates a historical data file, or a set of historical data files, and returns overall time, date, and record count information either for the entire file(set), or for a specified time range.
GetTagHistory (Historian Manager Library) Launched module that retrieves historical data for a tag. Replaces GetLog.
HistorianConnect Opens a logging connection and controls the lifetime of all resources associated with that connection.
LogNTEvent Logs events to the system event log.
SaveHistory This threaded function saves an array of data to a .DAT file for a certain time span.
TGet This threaded function reads an array of historical data from a file (written by Save or SaveHistory) and returns an indication of parameter errors.
Boolean (System Library) Takes a valid Boolean test and returns the numeric equivalent.
Case Selects one of a set of parameters for execution and returns its return value.
Cond Returns one of two values depending upon the result of a conditional expression.
DoLoop Executes a do-while loop in a script.
Execute Executes a group of statements as a single entity in structures that would otherwise allow only one statement to be executed.
False Evaluates to 0 or tests whether an optional parameter evaluates to 0.
ForceState Sets the next state to start when the action script completes.
If Trigger to perform an action. It changes the active state in a module instance or executes a script or does both.
IfElse Executes one of its two parameters based upon a condition parameter.
IfOne Check for an If One Condition. This function checks for a race condition in an action script and returns the value of the location.
IfThen Conditionally Execute Statements. This statement executes a statement if the condition parameter is true.
Invalid Return Invalid Value. This function always returns an invalid value.
PickValid Attempts to return a valid value given a list of parameters.
True Evaluates to 1 or tests whether an optional parameter evaluates to 1.
WhileLoop Repeatedly executes a parameter while a condition is true.
Abs Returns the absolute value of a numeric expression.
AMax Array maximum. This function returns the maximum value in a sub-range of a numeric array.
AMin Array minimum. This function returns the minimum value in a sub-range of a numeric array.
CommaFormat Returns the text version of a number, formatted to use embedded commas.
Deriv Returns the derivative (rate of change) of a value.
Edge Performs a test for a rising or falling edge.
Exp Returns the natural antilogarithm of a numeric expression.
FFT Performs a fast Fourier transform between time and frequency domains.
FitOffset Linear regression offset. This function returns the offset or Y intercept of the least square curve fit of data in a pair of arrays.
FitR2 Returns the coefficient of determination (i.e. r2) for a linear curve fit. This number gives a measure of how correct the curve fit is.
FitSlope Linear regression slope. This function returns the slope of the least square curve fit of data in a pair of arrays.
FormatInteger Returns a text string which is a decimal value converted to one of binary, octal or hexadecimal formats.
Intgr Time Integral. This function returns the time integral of a value.
Ln Returns the natural logarithm (base e) of a value.
Log Returns the common logarithm (base 10) of a number.
LValue Left-hand Side Value. This function returns an indication of whether its argument can be used on the left-hand side of an assignment.
Max Returns the maximum of a group of parameters.
Mean Returns the mean (average) of a portion of a numerical array.
Min Returns the minimum of a group of parameters.
PercentDifference Returns the percentage difference between two numbers
Pow Returns a number raised to a power.
Rand Returns a random number between 0 and 1.
Scale Returns a value that has been converted from one scale to another.
SDev Returns the statistical sample standard deviation for a subsection of an array.
Sqrt Returns the square root of a number.
Sum Returns the arithmetic sum of all the valid array elements in a specified portion of a numeric array.
SumBuff Returns the summation of bytes in a buffer.
Tag Returns a Tag value, which works like (and in place of) a Normalize value.
Variance Returns the statistical sample variance for a subsection of an array.
Ceil Returns the smallest integer greater than or equal to a number (the ceiling).
DeadBand Returns the previous value of the first parameter until it changes by an amount specified by the second parameter.
Int Integer Portion of Number. This function returns the portion of a number before the decimal point. Also used for rounding.
FormatNumber Returns a compactly formatted version of a number, containing at least the specified number of significant digits.
Limit Set Value Minimum and Maximum. This function returns a value that is limited both on the high and low ranges.
Step Transforms a continuous value into discrete steps.
ACos Calculates the trigonometric arc cosine in radians.
ASin Returns the trigonometric arc sine in radians.
ATan Returns the trigonometric arc tangent in radians.
Cos Returns the trigonometric cosine of an angle in radians.
Sin Returns the trigonometric sine of an angle in radians.
Tan Returns the trigonometric tangent of an angle in radians.
AddRead Add a read request. This module is called by a tag to add a request to read a specific range of memory and set the resulting read data into the variable pointed to by the third parameter. The pointer may be a simple variable for one element read, or an array if more than one element is requested.
CopyIn Copies data from an absolute RAM address and returns a buffer.
CopyOut Copies data from a buffer to an absolute RAM address.
DelRead Is called by a tag to delete an existing read request, as created by an AddRead.
In Read I/O Byte. This function returns the byte read from an I/O port.
InWord Read I/O Word. This function reads a 16 bit unsigned word from an I/O port.
MemIn Returns a byte, word, or longword of RAM memory.
Memory Returns the amount of memory that VTScada has acquired from the OS heap for internal use.
MemOut Writes a byte, word, or longword of RAM memory.
MemTrace Writes memory allocation information to a file.
New Allocates memory for an array from RAM and returns a pointer to that array.
Out Writes an 8 bit byte to an I/O port.
OutWord Writes a 16 bit word to an I/O port.
ModemCount Returns the number of data modems configured and operational in the system.
ModemDev Obtains the identifier for a modem sub-device. (In order to use the audio capabilities of a voice modem, the device identifier for the wave output device is required.)
ModemDial Dials and attempts to connect to a remote modem and returns the modem stream or an error code.
ModemDigits Controls the receipt of DTMF digits entered from the keypad of a telephone engaged on a voice call via a voice modem.
ModemList Returns a list of the modems in the system. This function should be used to determine the correct parameter for the ModemStream or ModemDial functions.
ModemMedia Enables you to determine the media mode of a serial stream open on a modem, and change it if necessary (for example, if you require the ability to be able to handle both incoming voice mode and data mode calls).
ModemStream Open a serial stream on a modem and returns its status (prior to the connection being made), a modem stream (after the connection has been established), or an error code.
ModemTransfer Transfers a modem call to another application and returns an indication of success.
PPPDial Creates a PPP connection to a remote peer. The connection can be via a dial-up or direct device connection.
PPPHandles Returns an array of all Point-to-Point Protocol handles on the local machine.
PPPDial Describes the status of a PPP connection.
ActiveCode ActiveCode returns the code value of the currently active statement in the given module instance.
AddModule Adds a new module to an existing module and returns the value of the newly created module.
AddParameter Adds an existing variable as a module parameter and returns the number of parameters in the module.
AdjustCode Adjusts the offsets and sizes of items stored in the .RUN file within the document file.
CalledInstances Returns the object values of module instances that are called by a particular module.
CanEditDoc Returns an indication as to whether the document for the given module can be edited.
ChildDocs Gets the module values for the root and all descendent modules that match the conditions defined by the second parameter.
CleanModule Removes the flag that marks when a module that has been changed programmatically and would therefore have its changes saved to disk were this flag not cleared.
ClearModule Deletes the contents (all variables and states) of a module without removing the module itself.
CodeText Returns the text (or other information) for a given Code Value.
ConstCount

Deprecated. Do not use in new code.
CoverageSnapshot Captures the areas in a VTScada source file which have not executed along with summary statistic for each module in the file to extract code coverage information.
CreateModule Creates a new module and returns a pointer to it.
CrossReference Returns a linked list of structures representing all references to a specified variable or module.
DeleteModule Deletes a module from the system.
FileRootModule Parses the document file that contains the given module to find the root module in that file. Returns the module value of the root module.
FormalParms Returns the number of formal parameters declared in a module.
GetModuleRefBox Get Module Reference Box
GetModuleText Returns information about a module's document file.
GetOneParmText Returns the text for one parameter of a function.
GetOverrides Returns an array of OpCodes and the module value that will run when each OpCode is executed
GetParameter Returns the requested parameters as a constant, variable or code pointer.
GetParmText Returns the text for all parameters of a function.
GetTagConfiguredParameters To be used with OPChange or ModifyTags, this API makes it possible to revert a tag parameter to its default or remove an override by changing some configured parameters while keeping others.
GetTransitText Get Transition Document Text. This function returns information about the documentation of an action.
GetXformRefBox Get Transform Reference Box. This function returns the reference box for any transform of a module.
GUITransform Applies a graphical transformation to all graphics in a module and returns an indication when selected by a mouse button or the <ENTER> key.
ImportAPI Imports objects of class API from a given module, for use in the calling module.
LoadModule Loads a module from its .RUN files and returns a pointer to that module.
MCSInstance Module Calling Structure Instance. This function returns the object value of a module called by another module.
MCSMod Module Calling Structure Module. This function returns the module value from a line of code that calls that particular module.
ModuleFileName Returns the full path (including the drive letter) and file name of the document (.SRC) file of a module.
NParm Returns the number of parameters listed in a module instance.
NumParms Returns the number of parameters of a statement.
OwningModule Returns the module which contains a certain variable.
Pack Packs a set of module parameters or an array of values into a stream, and returns the number of items that were not packed.
ParentModule Returns the parent module of a module.
ParentObject Returns the parent object of a module.
ParmToBuff Returns a buffer of formatted numeric parameter values.
PType Returns the actual type of parameter at an index.
RemoveParameter Removes a parameter from a module's parameter list.
ResetParm Can reset parameters that become latched.
ResyncDoc Synchronizes the time and date for the document and .RUN files.
RootTransform Returns the object value that contains the root transform applied to the given module.
RUNFileName Returns the name of the .RUN file for a module including the full drive and path.
RUNFileVersion Returns the minimum version of VTScada that can read the .RUN files produced by the current version.
SaveModule Saves a module definition to its *.RUN file.
SectionControl (System Library) Creates a control that displays a variable number of sections. Visually, a section consists of a header and content. The control manages the layout and geometry for the sections and runs a caller-supplied module to display the section content.
SetCodeText Will modify a source code file to replace the text for a given CodeValue with the new text.
SetModuleRefBox Sets the reference box for a single instance of a module.
SetModuleRefBox Sets the default reference box for a module.
SetModuleText Sets the module's .SRC file information.
SetOneParmText Sets the text for one parameter of a function.
SetOverride Allows the overriding of OpCodes with a specified script module within a static module tree.
SetParameter Sets a parameter in a statement.
SetParmText Sets the text for the parameters of a function.
UnTransform Will undo a previous transform so that the module instance and everything it has called will not be transformed.
UpdateCoordinates Will update a graphic statement's coordinates to the document file in which it is specified.
AddLock Creates a Control Lock on a selected tag.
CanAddLock Finds whether the user has the privilege to add a Control Lock.
CanControl (Control Lock Manager) Finds whether a tag is locked.
CanRemoveLock Finds whether the user may remove a lock.
Call Starts an instance of the module specified by its first parameter.
Caller Takes a given object value for a module and returns the object value of the module by which it was called.
ChildInstances Returns the object values of module instances that are children of a particular module instance (i.e. all objects whose parent is a specified object).
CriticalSection Marks a section of a module as a critical section and will not allow interruption of its execution by other threads.
DoOperate Used by tags that can be operated from the Tag Browser, this displays an input dialog where users can enter the new value to write. Should be overridden for use with tags other than those that write analog, digital or string values.
GetAllTagTypesInGroup Returns an array of all Tag Types in a Tag Group.
GetInstance Returns the object value of a module instance.
GetLockLevel Returns the Lock Level of a given Control Lock.
GetModuleTimeStamp  
GetTagList Returns an array of tags, starting at a given point in the tag tree and including all child tags below that point, subject to the filtering parameters.
GetTagMode Returns text or a structure to identify what kind of tag a given instance is.
GetTagTypes Returns an array of either the common names or the module names of all tag types.
GetReturnValue Returns a module's return value.
HasReturnStatement Examines a specified object to see if it is currently running a return statement in steady-state.
Instance Limit Module Instances. This function limits the number of fixed module instances allowed to run simultaneously and returns the old limit
IsChild Identify Child Module. This function returns an indication of whether one module is a child module of another.
IsTagOperable Returns TRUE if the user is able to operate the selected tag from the Tag Browser using the right-click menu.
Launch Runs a module instance and returns a pointer to it.
ListInstances Returns a list of all instances of a module.
LocalScope Equivalent to Scope(Obj, Name, TRUE).
LocalScope is a useful shortcut where the second parameter is not a constant string.
LocalVariable LocalVariable(Name) is a shortcut for Scope(Self, Name, TRUE).
NumInstances Returns the number of module instances currently running.
Parameter Returns the value of (or may assign a value to) a parameter of a module, specified by the index.
ParameterEdit Draws an interface to allow the user to choose how to edit a parameter. Used in tag widgets.
ColorParameterEdit ParameterEdit Wrapper - allow user to modify a color
DurationParameterEdit ParameterEdit Wrapper - allow user to set a time duration
MultiCheckboxParameterEdit Use this function to make any number of check boxes in a group.
NumericParameterEdit ParameterEdit Wrapper - allow user to modify a numeric value
TagParameterEdit ParameterEdit Wrapper - allow user to choose a tag
TextParameterEdit ParameterEdit Wrapper - allow user to enter a text value
TimestampParameterEdit ParameterEdit Wrapper - allow user to set a timestamp
UnTypedParameterEdit ParameterEdit Wrapper. Add control to a panel without defining the type.
PointList Returns an array of tag names within the current scope, given the name of a tag type or group.
Return Sets the return value for the module in which it is executed.
RemoveLock Removes a lock from a tag (assuming the current user has the privileges to do that.)
RootWindow Returns the object value of the root (original) module displayed in the same window.
Scope Performs a scope resolution and returns a reference to the requested member within a module or other object.
ScopeLocal Deprecated. As above except that ScopeLocal will not look outside the given context.
Self Returns the object value of the current module.
SetInstanceName Set the name of an instance of a module.
SetReturnValue Sets the return value of a specified object if the object is not currently running a Return() statement in steady state.
Slay Stops a launched module, and possibly any parent modules.
SystemSelf Returns the object value of the system module for the given application.
Thread Launches a module in its own separate thread.
ThreadHistory Returns in an array the history of execution for a specified thread.
ThreadIdle Returns TRUE when the ToDo list for a given thread is empty.
ThreadList Returns a two dimensional array containing the name and statement last executed by each VTScada thread.
ThreadName Returns the name of a thread.
ThreadPriority Allows advanced users to set a specified thread to one of six priorities, ranging from idle to time critical.
WCSubscribe Working Copy Subscribe. After this function has been called, any configuration change will result in the specified callback subroutine being called.
Window Opens a new window, starts a module inside, and eventually returns the module's value.

See also: RPC Manager Functions.

CheckIPMask Determines whether an IP Address is in the address ranges defined by MaskSet.
GetAdaptersInfo  
GetGUID Creates a globally unique identifier or converts an existing GUID to another format.
GetHostByName Calls the WinSock gethostbyname function and returns the host name, address(es) and alias names for the named computer.
GetPowerState Returns a structure that describes the state of the power supply to the workstation. Relevant when the workstation is running on battery power.
IPMaskToText Extracts an IP mask from MaskSet and converts it to text, returning the new text value.
LocalGroup Returns an indication of whether the current Windows™ user is a member of the specified local group. LocalGroup interrogates only local groups, not domain groups.
MakeIPMask Make an IP mask set by returning text holding the encoded binary IP address and mask. Works for IPv4 and IPv6.
OPCServer Adds a new top-level branch to the VTScada OPC Server’s namespace hierarchy.
GetOPCServerRequestRate Returns the total number of OPC Classic callbacks per second.
Platform Returns a twelve element structure that indicates the platform under which VTScada is currently running.
Redirect Redirects a local device to network resource.
Register (RPC Manager) (RPC Manager Library) This subroutine registers a service for RPC and returns a pointer to the variable containing the current RPC status of the service.
RunPack (RPC Manager Library) Is unpacks and executes a set of RPCs from a stream constructed with PackRPC.
Send (RPC Manager Library) This subroutine sends a message by invoking a remote procedure call (RPC).
ServerList Returns a pointer to an array of all available servers visible from this workstation.
ServerSocket Returns a server WinSock socket stream given a handle returned by a SocketServerStart function or an integer error code.
SetAllBlocks (RPCManager Library) This subroutine executes on the client. It accepts all of the blocks and data for a service.
SetOPCData Sets an item value in the VTScada OPC Server.
TServerList Executes in its own thread and creates a pointer to an array of all servers visible from this workstation. Returns a flag indicating its status upon completion.
WKSList Generates a list of sub-paths from the query returned by the WKSPath function.
WKSPath Given set of path components, generates a query path for use in the WKSStatus command.
WKSStatus Sends a query to the Windows™ Performance Monitor interface (see image in WKSPath) and returns the result as a query handle.
WKStaInfo Returns the characteristic information about this workstation.
AddConnection (ODBC Manager Library) Called to get the object value of an ODBC connection. If the connection does not exist, then a new ODBC DSN connection will be created and explicitly added to the ODBC Manager's internal list of DSN's
ErrMessage (ODBC Manager Library) Returns a text message for the error code handed to it as a parameter
ODBC Performs an ODBC command and returns a (dynamically allocated) array if required.
ODBCBeginTrans Indicates to a specified ODBC-compliant database that a transaction is to be started.
ODBCCommit Indicates to a specified ODBC-compliant database that a transaction is to be committed.
ODBCConfigureData Configures an ODBC data source and returns its error code.
ODBCConnect Forms a connection to an ODBC-compliant database and returns the ODBC value associated with that database.
ODBCDisconnect Stops a connection to the ODBC database.
ODBCRollback Indicates to a specified ODBC-compliant database that a transaction is to be rolled back (discarded).
ODBCSources Retrieves a list of ODBC data sources and returns it as a (dynamically allocated) array.
ODBCStatus Returns the requested information about the last ODBC statement to execute.
ODBCTables Retrieves a list of the tables present in an ODBC-compliant database and returns it as a dynamically allocated array.
ResultFormat (ODBC Manager Library) Subroutine to convert 2-d array as returned from query in the form, Arr[Field][Rec], to a normalized format of Arr[Rec][Field].
SQLQuery A launched module that executes an SQL query on data in a VTScada application.
TableSynch (ODBC Manager Library) Synchronizes the fields matching a specified criteria within matching tables in two databases. Should be run as a called module, waiting for completion. Do not call as a subroutine.
TODBC Performs an ODBC command. Similar to ODBC except that it runs in its own thread.
TODBCBeginTrans Indicates to an ODBC-compliant database that a transaction is to be started. TODBCBeginTrans is similar to ODBCBeginTrans, except that it runs in its own thread.
TODBCCommit Indicates to an ODBC-compliant database that a transaction is to be committed. TODBCCommit is similar to ODBCCommit, except that it runs in its own thread.
TODBCConnect Forms a connection to an ODBC database. Similar to ODBCConnect except that it runs in its own thread.
TODBCDisconnect Stops a connection to the ODBC database. Similar to ODBCDisconnect except that it runs in its own thread.
TODBCRollback Indicates to an ODBC-compliant database that a transaction is to be discarded. TODBCRollback is similar to ODBCRollback, except that it runs in its own thread.
Transaction (ODBC Manager Library) Launches a transaction in the specified database connection. The transaction takes care of its own shut-down process.
TransactionCached (ODBC Manager Library) Launches a transaction in the specified database connection. The transaction will be cached locally if it fails and then sent to the database after the next successful transaction. This module is designed to provide logging of values that must not be lost.
OilVolumeCorrectionFactor Returns a coefficient to adjust a volume of oil to different temperature and pressure conditions.
OilVolumeCorrectionToBase Wrapper for OilVolumeCorrectionFactor, used to determine the volume correction factor for shifting a fluid at alternate conditions to standard conditions (60°F, 0 psig).
ShellTemperatureCorrection Returns a coefficient to adjust the calculation of volume within a tank.
TableInterpolation Given a graph described by a CSV file containing X and Y values, this function will interpolate a Y value for any provided X value within the range of the graph.
ParameterEdit Draws an interface to allow the user to choose how to edit a parameter. Used in tag widgets.
ColorParameterEdit ParameterEdit Wrapper - allow user to modify a color
DurationParameterEdit ParameterEdit Wrapper - allow user to set a time duration
MultiCheckboxParameterEdit Use this function to make any number of check boxes in a group.
NumericParameterEdit ParameterEdit Wrapper - allow user to modify a numeric value
TagParameterEdit ParameterEdit Wrapper - allow user to choose a tag
TextParameterEdit ParameterEdit Wrapper - allow user to enter a text value
TimestampParameterEdit ParameterEdit Wrapper - allow user to set a timestamp
UnTypedParameterEdit ParameterEdit Wrapper. Add control to a panel without defining the type.
PAddressEntry To be used for Tag I/O address entry. Checks whether the attached driver has an AddressAssist module and uses that if available.
PAlmPriority Draws a droplist of the currently available alarm priorities with an optional title and bevel.
PCheckBox Parameter Setting check box. This module draws a check box with optional label.
PColorEdit Wrapper module for the standard color editing parameters including hue, saturation, brightness, transparency, contrast, colorizing hue and intensity.
PColorSelect Draws a button that opens a color selection dialog and an area that displays the currently selected color.
PContributor Draws a split list displaying all contributors to a specific tag.
PDroplist Parameter Setting Droplist. This module draws a droplist with (optional) title and bevel.
PEditField Parameter Setting Editfield. This module draws an editfield with (optional) title and bevel.
PEditName An edit field for setting tag names. This module draws an edit field that is to be connected to the name of a tag.
PFileChooser Parameter setting file selection. Provides an edit box for specifying a file name, along with a label and a browse button.
PHSliderBar Called graphic module that connects a horizontal slider bar to a given parameter number.
PHueSelect Called graphic module that connects a hue selection tool to a given parameter number.
PImageSelect Called graphic module that connects an image selection tool to a given parameter number.
PIPAddressList Uses an IPAddressList to set a parameter with a semicolon-delimited IP address list.
PIPListenerGroup Draws a droplist of all available IP Listener Groups.
PMultiCheckBox Tool used to display the standard set of check boxes.
PPageSelect Draws a titled, beveled droplist of pages in the system.
PPhraseDroplist Handles the complexity of parameter expressions by switching between display of a PhraseDroplist and regular Droplist control as is done in PPhraseEdit.
PPhraseEdit Language-sensitive, parameter-setting editfield. This module draws an editfield with (optional) title and bevel.
PRadioButtons Parameter Setting Radio Buttons. This module draws a set of labeled radio buttons with optional title and border.
PSecBit Parameter Setting Security Bit. This module draws a titled, [beveled] droplist of options for setting the security bit.
PSelectObject Parameter Setting Select Tag Object Tool. This module draws a beveled, titled box showing the currently selected tag, a button to modify the connection in the hierarchy, and a new tag creation button.
PServerListName Called graphic module that creates an editable droplist of Server List Names, available to the tag.
PSpinbox Parameter Setting Spinbox. This module draws a spinbox with optional label.
PTimeZone Tool used to display a list of timezones, as defined by the operating system.
PTypeToggle Parameter Setting Type Toggled Field. This module draws a beveled, titled box showing the currently selected tag, numeric value or expression and buttons to modify the value as appropriate.
PWidgetSelect  
DefaultPrinter Returns the Windows® default printer.
Print Allows text to be printed.
PrintDialogBox Displays a threaded system common printer selection dialog box.
PrintLine Allows text to be printed and is followed by a carriage return-line feed to the printer.
PrtScrn Prints the image in a window on the default Windows® printer and returns an error code.
Redirect Redirects a local device to network resource.
ProtobufDecode Decodes Protobuf serialized data.
ProtobufEncode Creates a buffer for a given Protobuf file containing VTScada value data.
ProtobufInstantiate Instantiates a message using default values.
ProtobufParse Load a Protobuf specification from a file.
GetCurrentRecipe Returns the name of the current recipe
GetCurrentVersion Returns the current version of the current recipe
GetRecipes Returns the current version of the current recipe
GetVersions Returns an array of the versions found in the current or specified recipe
SetCurrentRecipe Sets the current recipe and clears or updates the current version
SetCurrentVersion Sets the version of the current recipe
GetOutputTypes Returns a list of available report output type plugins.
GetReportTypes This subroutine returns a list of available report type plugins.
BinIP2Text (RPC Manager Library) Returns a text representation of a specified binary IP in a printable format.
ConnectToMachine (RPC Manager Library) This subroutine increments the usage count on the specified workstation and forces RPC Manager to attempt to establish a connection with the specified workstation if it is not already connected. Subroutine call only.
DisconnectFromMachine (RPC Manager Library) This subroutine disconnects from a workstation by decrementing the usage count on the specified workstation and forcing the RPC Manager to attempt to establish a connection with the specified workstation if it is not already connected. Subroutine call only.
ForceServers (RPC Manager Library) Sets the servership of an application service to a specific state.
GetAllWorkstationNames (RPC Manager Library) Launched module that creates an alphabetically sorted list of all known workstation names. The list is not service specific.
GetClientDiverts (RPC Manager Library) Returns a one-dimensional array of flags, indicating the divert status of each client.
GetClientGUIDs (RPC Manager Library) Returns a one-dimensional array of the application GUIDs of the clients of the specified RPC service instance.
GetClientIPs (RPC Manager Library) Returns a one-dimensional array of the IPs of the clients of the specified service instance.
GetClientList (RPC Manager Library) Returns a one-dimensional array of the names of the clients of the specified service instance. Steady state or subroutine call.
GetClientMode (RPC Manager Library) Returns a one-dimensional array of the modes of the clients of the specified service instance.
GetClientNodes (RPC Manager Library) Returns a one-dimensional array of the object values of the MachineNodes of the clients of the specified service instance. Steady state or subroutine call.
GetInhibitedServiceList (RPC Manager Library) Returns a one-dimensional array of the names of all services inhibited from RPCManager servership control.
GetInSyncServers (RPC Manager Library) Returns a one-dimensional array of the names or IPs of the potential, synchronized servers for the given service.
GetIP (RPC Manager Library) Returns an IP address for a workstation, given its name.
GetLastUsedSubnet (RPC Manager Library) Returns the last CIDR representation of the subnet or remote IP used for communication with the specified machine.
GetLocalIP (RPC Manager Library) Returns an IP address for the local workstation that is known to the specified remote workstation.
GetLocalNumber (RPC Manager Library) Returns the index of the local workstation down the prioritized server list for the named service. Steady state or subroutine call.
GetMachineNode (RPC Manager Library) Returns the object value of the MachineNode for the specified name or IP. Steady state or subroutine call.
GetMakeAltPtr (RPC Manager Library) Returns a pointer to a variable containing the Alternate status for the local service instance in the calling application for the specified service. Steady state or subroutine call.
GetPreferredSubnet Returns the highest priority CIDR representation of subnet for the given machine name.
GetRemoteVersion (RPC Manager Library) Returns the version number of VTScada running on a specified workstation. Steady state or subroutine call.
GetServer (RPC Manager Library) Returns the name of the currently active server for a specified service.
GetServerChanges (RPC Manager Library) Launched by RPC Manager on a service server to obtain the service's synchronization data (i.e. called by RPC Manager during startup synchronization on a server to get the package of RPCs that create a synchronizable state on the client which is in step with the server).
GetServerMode (RPC Manager Library) Returns the mode in which the current server for a specified service is running.
GetServerNumber (RPC Manager Library) Returns the index down the prioritized server list of the current server for the specified service. Steady state or subroutine call.
GetServerSIDPtr (RPC Manager Library) Returns a pointer to a variable that holds the session ID for the current server for the specified service.
GetServersListed (RPC Manager Library) This subroutine returns a one-dimensional array of the names or IPs of the servers that has been derived from the "-Servers" section of the service configuration file.
GetServiceScope (RPC Manager Library) Returns the service instance for a service.
GetSessionID (RPC Manager Library) Returns the current session ID for a specified application on a workstation.
GetSocketStatus (RPC Manager Library) Returns the connection status of either: 1) The machine node if the subnet is not valid, or 2) The socket that is on the specified subnet.
GetStatus (RPC Manager Library) Returns a variable that holds the current service instance status for the specified service.
GetSubnetPriority (RPC Manager Library) This module returns a full set of network priority values configured
IsClient (RPC Manager Library) Is Client of a Service. This subroutine returns an indication of whether a particular workstation is a client connected to a service. Returns 1 for the specified service if the specified machine is currently a client to the machine on which the IsClient() call is made.
IsMatch (RPC Manager Library) Determines whether two names or IPs indicate the same workstation. This subroutine returns a 1 if the two names or IPs (any combination) refer to the same workstation.
IsPotentialServer (RPC Manager Library) Is Potential Server for a Service. This subroutine returns an indication of whether the local workstation is a potential server for a service. Returns 1 if the local workstation can be a server for the specified service. IsPotentialServer should not be called in steady state.
IsPrimaryServer (RPC Manager Library) Returns 1 if the local machine is connected to the primary server for the specified service.
IsServiceReady (RPC Manager Library) Is Primary Server Active for a Service. Only available in VTS 6. This module returns an indication of whether the specified server is in synchronization with the server instance. Returns 1 if the local instance is in synchronization with the server instance.
PackParms (RPC Manager Library) This method packs supplied parameters into a stream. Subroutine call only.
PackRPC (RPC Manager Library) Packs an RPC call and a set of parameters into a stream. Subroutine call only.
ReadLock (RPC Manager Library) Attempts to acquire a Read lock for the specified service. Subroutine call only.
RecommendAlternate (RPC Manager Library) Instructs RPC Manager that the local service instance does not consider itself a good server candidate.
RecommendPrimary (RPC Manager Library) Instructs RPC Manager that the local service instance considers itself a good server candidate.
Register (RPC Manager) Registers a service for RPC and returns a pointer to the variable containing the current RPC status of the service.
RunPack (RPC Manager Library) Is unpacks and executes a set of RPCs from a stream constructed with PackRPC.
Send (RPC Manager Library) This subroutine sends a message by invoking a remote procedure call.
SetDivert (RPC Manager Library) Informs RPC Manager that the synchronization state of a service has been sampled during synchronization, and service RPCs for the specified client should be buffered until synchronization completes. Subroutine call only.
SetRemoteValue (RPC Manager Library) This subroutine sets the specified variable within an application instance on a workstation to the specified value. Subroutine call only.
SetSubnetPriority (RPC Manager Library) This module enables setting the network priority configuration during runtime.
SetSyncComplete (RPC Manager Library) Informs RPC Manager that service synchronization is complete as far as the local service instance is concerned. Subroutine call only.
TextIP2Bin (RPC Manager Library) Returns the Binary representation of the specified IP.
UnpackData (RPC Manager Library) This method unpacks a stream into an array or set of module instance parameters. Subroutine call only.
UnpackParms (RPC Manager Library) This method unpacks a stream into the supplied parameters. Subroutine call only.
WriteLock (RPC Manager Library) This subroutine attempts to require a Write lock for the specified service. Subroutine call only.

Account Manipulation Methods

AddAccount Creates a new account.
ModifyAccount Modifies an existing account.
DeleteAccount Removes an account.

Query Module

SecurityCheck Examines the rules that apply to the current user or the named user to determine if the specified privilege has been granted.
BuildFullName If a namespace and namespace delimiter are being used, returns the full, namespace-qualified name of the specified account.
GetFullName Returns the full, namespace-qualified name of the caller's account.
GetGroupName Returns the namespace of the caller's account.
GetUserName Returns the user name of the caller's account.
GetAccountID Returns the account ID of the named account.
GetAccountInfo Returns one or more AccountData structures.
IsLoggedOn Returns TRUE if the calling user is signed in, else FALSE.
IsSecured Returns TRUE if the application has any user accounts defined, else FALSE.
IsSuspended Returns TRUE if the user's account is suspended, else FALSE.
UIErrorToText Returns a text string corresponding to the error code provided.

VTScada Authentication Module

AlternateLogon Either creates, or attempts to sign in using an alternate ID value.
AlternateLogoff Synonym for LogOff().
Authenticate Authenticates the NameSpace, UserName and Password.
QuietLogon Authenticates the authorization token (AuthToken) and, if successful logs the calling user session on as the user specified in the AuthToken.
LogOff Logs the calling user session off.
UserCredChange The return value will increment each time there is a change in the user session's logged-in user or their password.

Windows Authentication Module

AcceptSecurityContext Accepts a Kerberos security context from a client and returns the user principal name (UPN) from the context, along with any output to be returned to the client for mutual authentication.
DefaultNamingContext Returns the string value of the LDAP default naming context for the host machine domain.
GetLogonCredentialsFromSmartcard Monitors the card reader for a smartcard and reads the certificate information from it
WindowsLogon Authentication request to Windows Authentication services.

User Interface Module

UserLogonDialog Launches the Logon dialog.

Other

OkToWrite Returns true if a user is permitted to control a particular tag on a particular workstation.
VICSmartcardMonitor Enables and disables Smartcard monitoring on a VIC and outputs authentication information received from the VIC when a Smartcard is used.
VICSmartcardResponse Returns the result of the Kerberos Security negotiation after processing a sign in attempt on the VIC.
COMPort Opens a serial port and handles all interrupts and asynchronous events for that serial port, including transmission, reception, and control. It returns its own error code. Please note that the SerialStream function is generally preferred in many situations, however, ComPort continues to be supported.
PPPDial Creates a PPP connection to a remote peer. The connection can be via a dial-up or direct device connection.
SerBreak Sends a break character to a serial port.
SerCheck Check Serial Port. This function returns the immediate or cumulative serial port status.
SerialStream Returns a serial stream that can be used in any of the serial port functions or with any of the stream functions. Please note that the ComPort function (which functions somewhat differently than the SerialPort function) may also be utilized.
SerIn Get Serial Port Byte. This function returns the next byte in the receive buffer.
SerLen Serial Port Buffer Length. This function returns the number of bytes currently in the receive or transmit buffers.
SerOut Send Serial Port Byte. This statement sends a byte to the transmit buffer.
SerRcv Serial Port Receive. This function returns a buffer containing a string read from the receive buffer.
SerRTS Sets or clears the RTS line on a serial communication port.
SerSend Serial Port Send. This function writes a string to the transmit buffer and returns the number of bytes written.
SerStrEsc Serial Port Receive With Escape. This function reads the receive buffer until an escape code is encountered and returns the final offset in the buffer.
SerString Serial Port String Receive. This function reads the receive buffer until a string is encountered and returns the final offset in the buffer.
CommandLine Returns any command line arguments as a text string.
DriveInfo Returns information about a disk drive.
GetConfiguration Returns the configuration parameters from the license key for this copy of VTScada.
IsRunning Check if a Program is running. This function returns an indication of whether a certain program is currently running on the same computer.
LoadDLL Loads a Microsoft Windows™ dynamic link library.
LoadMIB Loads a specified MIB or set of MIBs and returns a dictionary describing the hierarchy of the MIBs.
MACID Enumerates and returns the MAC IDs registered on a particular machine.
Platform Returns a twelve element structure that indicates the platform under which VTScada is currently running.
ProcInfo Returns basic information about the VTScada process.
Redirect Redirects a local device to network resource.
SerialNum Returns the serial number of the copy of VTScada running.
Spawn Runs another Windows™ program.
Stop Causes the immediate termination of VTScada, closing all windows.
ThreadList Returns a two dimensional array containing the name and statement last executed by each VTScada thread.
ThreadName Returns the name of a thread.
Version Returns the version number of the copy of VTScada currently running.
VersionRequired Returns the version number of VTScada that is required to execute any .RUN files loaded since the last execution of this statement.
VStatus Returns the video board and screen characteristics for VTScada.
WKSPath Given set of path components, generates a query path for use in the WKSStatus command.
WKSStatus Sends a query to the Windows™ Performance Monitor interface (see image in WKSPath) and returns the result as a query handle.
WKStaInfo Returns the characteristic information about this workstation.
AudioFileLength (System Library) Returns the length of a RIFF format Wave file in seconds.
Beep Causes a tone to sound on the computer's internal speaker.
Configure Is used to define how a speech stream will sound and where it will be heard.
GetDevices Runs in the VoiceTalk thread and returns a list of devices available on a SAPI text-to-speech stream.
GetVoices Runs in the VoiceTalk thread and returns a list of voices available on a SAPI text-to-speech stream.
MuteSound (Alarm Manager module) This subroutine is used to turn off alarms sounds for all alarms, both current and future.
Play Plays a multimedia sound file as installed in the operating system. It differs from Sound in that it is a steady-state statement and is supported by the VTScada Internet Client (VIC).
Reset Immediately stops a speech stream and cancels any buffered speech.
ShowLexicon Displays a SAPI text-to-speech engine lexicon dialog to permit modification of pronunciation. This function will return immediately, and the lexicon window will be managed in its own thread, preventing the calling thread from being blocked.
Sound Plays a multimedia sound file as installed in the operating system.
Speak Executes on the speech thread to speak the supplied text through a specified SAPI text-to-speech stream.
SpeakToFile Executes on the speech thread to speak the supplied text to a .wav format audio file.
VoiceTalk Opens and returns a handle to a SAPI text-to-speech stream.
ActiveState ActiveState returns the code value of the currently active state in the given module instance.
AddOptional Adds a new statement to an action script and returns its own error code.
AddPageToApp (Obsolete) Creates a new application page.
AddState Adds a new state to an existing module and returns its state value.
AddStatement Adds a new statement to an existing state and returns its own error code.
ClearState Deletes all of the statements in a state.
DeleteOptional Deletes a statement from an action script.
DeleteState Deletes a state from a module.
DeleteStatement Deletes a statement from a state.
FindAction Returns an action from the list of actions in a state.
FirstState Sets the first state in a module.
ForceState Sets the next state to start when the action script completes.
GetState Returns the code value for the specified state.
GetStatement Returns the code value for the specified statement.
GetStatementNum Returns the statement number for the specified statement.
GetStateText Returns the text for the specified state.
ReplaceStatement Replaces a statement with another statement.
SetStateText Sets the information about the text of a state in a .SRC file.
SetTransfer Sets the destination for an action.
StateList Returns a list of states for a module.
StatementInstance Takes a given code value and object and returns a code pointer value for that instance.
StateName Returns the text name of the given state.
SubStatementIndex Returns the index of a function within the statement where it is called.
BlockWrite Writes a block of data to a stream.
BuffStream Returns an in-memory read/write (expanding) buffer stream.
ClientSocket Opens a client WinSock-compliant socket stream and returns a stream value, or a numeric error code.
CloseStream Closes and flushes any type of open stream and returns its own error code.
CommaFormat Returns the text version of a number, formatted to use embedded commas.
DBGetStream Executes in its own thread to convert a database to a stream, and returns an indication of parameter errors.
FileStream Returns a stream attached to a disk file or printer, and is suitable for use in SWrite.
Flush Pushes the data in all software caches associated with a FileStream directly to the physical media.
GetStreamLength Returns the present length of a stream in bytes.
GetStreamType Returns a type indication for a stream.
GetToken Reads the next token from a stream and returns the token type.
HTTPSend Sends HTTP requests to an HTTP server
In Read I/O Byte. This function returns the byte read from an I/O port.
LargeSocketWrite Paces the write speed to prevent exceeding the socket output buffer limit.
ListCertificates Enumerates X.509 certificates in a certificate store resident on the local computer.
Pack Packs a set of module parameters or an array of values into a stream, and returns the number of items that were not packed.
PackParms (RPC Manager Library) This method packs supplied parameters into a stream. Subroutine call only.
PackRPC (RPC Manager Library) Packs an RPC call and a set of parameters into a stream. Subroutine call only.
PeekStream Returns a string of bytes from a stream without removing them from the stream.
PipeStream Returns a stream based on an operating system named pipe.
Read (VTSDriver Library) Used to create a request for a single read of a given driver address. (This is in contrast to the polled read request of the AddRead function).
ReadBlock (VTSDriver Library) Is launched to read a block of data from the PLC. It maintains a linked list of pointers to tag values with their absolute offset into the PLC file being read by this instance.
RunPack (RPC Manager Library) Is unpacks and executes a set of RPCs from a stream constructed with PackRPC.
Seek Changes and returns the current position within a stream. The return value is the current stream position after the seek is done.
SerialStream Returns a serial stream that can be used in any of the serial port functions or with any of the stream functions. Please note that the ComPort function (which functions somewhat differently than the SerialPort function) may also be utilized.
ServerSocket Returns a server WinSock socket stream given a handle returned by a SocketServerStart function or an integer error code.
ShiftStream Inserts or deletes characters from a stream and returns its own error code.
SocketAttribs Returns information about a TCP/IP socket's attributes.
SocketPingSetup Starts the transmission of automatic keep-alive "ping" messages through a socket stream.
SocketServerEnd Ends a TCP/IP socket server.
SocketServerStart Starts a TCP/IP or UDP socket server and returns a handle to it.
SocketServerManager\Register Register a station with a group
SocketServerManager\UnRegister Unregister a station from a group. The station must be unregistered whenever GroupName, or StationKey changes.
SocketWait Wait for Socket Connect. This function returns true when a client connects to a socket offered by a socket server.
SRead Reads values from a formatted stream and returns the number of values not read.
StreamEnd Returns whether a stream is at the end.
SWrite Performs a formatted write of ASCII or binary data to a pre-existing stream and returns the number of data items not written.
TempFileStream Uses the OS tmpfile() function to create a temporary file on disk and to connect a stream to the temporary file. The temporary file is removed when the stream is closed or no longer referenced or if the VTScada process is terminated.
Unpack Unpacks a set of values from a stream into a single dimensional array or a set of variables referenced by object parameters, and returns the number of items unpacked.
UnpackData (RPC Manager Library) This method unpacks a stream into an array or set of module instance parameters. Subroutine call only.
UnpackParms (RPC Manager Library) This method unpacks a stream into the supplied parameters. Subroutine call only.
Write (VTSDriver Library) Used by a tag to create a write request to a driver address.
Zip Generates a zip archive of a file stream.
ArrayToBuff Returns a buffer containing the numeric data from an array.
BinaryToIP Converts an IP address from binary notation to decimal.
BinIP2Text (RPC Manager Library) Returns a text representation of a specified binary IP in a printable format.
BuffOrder Reverses the order of groups of bytes in a buffer, and returns a new (rearranged) buffer.
BuffRead Reads values from a formatted buffer and returns its own error code.
BuffStream Returns an in-memory read/write (expanding) buffer stream.
BuffToArray Reads an array from a formatted buffer containing numerical data and returns the number of elements read.
BuffToHex Convert a buffer of numeric data to a hexadecimal value.
BuffToParm Convert buffer of numeric data to parameters. This function reads module parameters from a formatted buffer containing numerical data and returns the number of data items read.
BuffToPointer Converts a buffer of numeric data to array of pointers. This function reads from a formatted buffer containing numeric data, writes to locations specified by an array of pointers, and returns the number of elements read.
BuffWrite Writes formatted values to a buffer and returns the number of values not written.
CharCount Returns the number of bytes in a section of a buffer that matches a search character.
ClipboardGet Returns the current contents of the system clipboard as a string. This function enables an application to perform text "paste" operations.
ClipboardPut Set the current contents of the system clipboard to a string. This function enables an application to perform text "copy" or "cut" operations.
Concat Returns the text value that is the concatenation of all the text parameters.
CRC Returns the cyclic redundancy check (CRC) value for a buffer.
CRCTable Returns a buffer containing a CRC table.
Deflate Compresses/decompresses a buffer of data using the DEFLATE algorithm, and returns the compressed/decompressed data.
Diff Compares two buffers and generates a third buffer containing formatted instructions describing how the first buffer can be modified so that it will match the second. This will perform a delimited difference unless the ChunkSize parameter is set to 1 or greater.
EncodeURIComponent Encodes a string so that it can be embedded as part of a Uniform Resource Indicator.
Escape Wrapper for EncodeURIComponent.
FileChooser Provides an edit box for specifying a file name, along with a label and a browse button.
Format Returns a text string corresponding to numbers in a specified format.
FormatInteger Returns a text string which is a decimal value converted to one of binary, octal or hexadecimal formats.
FRead Reads values from a formatted file and returns the number not read.
FWrite Writes ASCII or binary data to a file and may also be used to create or delete a file. It returns the number of data items not written.
GetByte Returns a single byte from a buffer.
GetDatePhrase Returns a formatted date for the current user's locale
GetTimePhrase Returns a formatted time for the current user's locale
GetParmPhrase Returns parameterized text in the currently selected language for a given phrase identifier key.
GetParmPhraseForLang Returns parameterized text in the specified language for a given phrase identifier key
GetPhrase Returns text in the currently selected language for a given phrase identifier key
GetPhraseForLang Returns text in the specified language for a given phrase identifier key
GetPhraseID Returns the key matching a given phrase.
GetRawPhrase Returns a phrase in the provided language, if it exists.
HexToBuff Converts a hex string to a binary buffer.
IPAddressList Displays a list of IP address which can be added to or removed from.
JoinStrings Joins an array of string elements together into one string, with a given separator added between each element from the array.
JSON_Encode Deprecated. Use JSONEncode instead.
JSONEncode Converts any given VTScada value into a JSON string using UTF-8 encoding.
JSONParse Parse JSON text, converting it to VTScada arrays, objects/structures, strings or other data types as appropriate.
KeyFake Places a string of characters in a window's keyboard buffer.
Keys Returns the most recently pressed keys from either the edited or non-edited keystrokes.
Locate Locates a text string, returning the offset of the first matching string in a buffer.
MakeBuff Creates a buffer and returns its address.
MakeValidFName Create a file name that is guaranteed to contain only legal characters.
ParmToBuff Returns a buffer of formatted numeric parameter values.
PatternMatch Compares a string against a reference pattern and returns true if the string matches the pattern. Along with literal characters, PatternMatch currently supports the * and ? wildcard characters within the reference pattern.
PlotBuff Displays a plot of a subsection of a buffer in a particular area of the window after converting the buffer to element values.
PointerToBuff Returns a buffer containing the numeric data from the variables pointed at by each element of the array.
PrepStringForTemplate Prepares text for use in an alarm template by escaping % symbols.
Replace Performs a search and replace operation on a buffer and returns the resulting buffer.
Reverse Returns its parameter with the byte order reversed.
SerLen Serial Port Buffer Length. This function returns the number of bytes currently in the receive or transmit buffers.
SerOut Send Serial Port Byte. This statement sends a byte to the transmit buffer.
SerString Serial Port String Receive. This function reads the receive buffer until a string is encountered and returns the final offset in the buffer.
SetByte Writes a single byte to a buffer.
SetUserLanguage Changes the display to any of the languages currently enabled in the application.
SplitString Splits a string into separate array elements using a given delimiter to mark the breaks between elements in the string.
StrCmp Performs a case sensitive comparison of two text expressions and returns an indication of whether the first string is greater than, less than or equal to the second.
StrICmp Case Insensitive Text Comparison
StrJustify Reformats a string to have maximum line length.
StrLen Returns the length of a text string.
SubStr Returns a string that is a portion of another string.
SumBuff Returns the summation of bytes in a buffer.
TextEncode Takes text in the local code page and converts it into UTF-8 encoded text where a suitable conversion exists.
TextIP2Bin (RPC Manager Library) Returns the Binary representation of the specified IP.
TextSearch Returns the array index of the first occurrence of the given text key in an alphabetically ordered array.
TextSize Returns the size in characters of the definition text of a desired item.
TrimSpaces Returns text with leading and trailing spaces removed.
ToLower Returns a text string with all the characters converted to lower case.
ToUpper Returns a text string with all the characters converted to upper case..
UnEscape Decodes a string that was URL-encoded by EncodeURIComponent.
WrapText Breaks a text string based on given font and width and returns the text segments in an array.
Write (VTSDriver Library) Used by a tag to create a write request to a driver address.
AbsTime Absolute time. This function returns true when a fixed time has been reached.
ConvertTimeStamp Converts a timestamp from one time zone to another.
CurrentTime Returns the number of seconds, in local or UTC time, since midnight of January 1, 1970 (where "midnight" is 00:00).
Date Returns a text string giving the date that corresponds to the number of days since January 1, 1970.
DateNum Returns the number of days since January 1, 1970 for a given date.
DateSelector Displays a calendar, from which operators can select a date.
Day Returns the day of the month for a given date number.
GetDatePhrase Returns a formatted date for the current user's locale
GetISOTSfromTS Convert ISO 8601 date & time format to a VTScada timestamp.
GetTimePhrase Returns a formatted time for the current user's locale
GetTSfromISOTS Convert a VTScada timestamp to ISO 8601 date & time format.
HoursEntry Displays a time editing field.
Month Returns the month for a given date number.
Now Returns the current time in seconds since midnight.
RTimeOut Cumulative Timer. This function returns true when the total time that an expression is true reaches the specified value.
Seconds Returns the number of seconds since midnight of the current day.
SetClock Sets the VTScada system clock and calendar.
Time Returns a formatted string for a time of day.
TimeArrived Indicates whether a given time has occurred.
TimeOut Returns true when the uninterrupted time that an expression is true reaches the specified value.
TimeUtils Library that exposes a dictionary of time periods and subroutine to calculate relative time periods.
TimeZone Returns information on the current time zone setting of the machine.
TimeZoneList Returns an array of names of time zones that are available on the system.
Today Returns the current number of days since January 1, 1970.
UnEscape Decodes a string that was URL-encoded by EncodeURIComponent.
Year Returns the year for a given date number.
Accumulate Adds a tag and a value to be counted for that tag, to a named accumulator.
AddVariable Adds a new variable to an existing module and returns its variable value.
Cast Takes a value and returns a different type of value, if possible.
Change Returns a true when the value of the first parameter changes by at least the value of the second parameter.
  Changes the space allocated in the persistent value (.VAL) file for a variable.
CheckTagGroup Returns TRUE or FALSE according to whether a tag is in the specified group.
DeleteVariable Deletes a variable from a module.
Dictionary Creates a database-like storage structure that provides efficient addition, retrieval and removal of information linked to key values.
DictionaryCopy Create a new dictionary with contents identical to an existing dictionary. It is expected that this function will be used rarely, since in most cases it will be more efficient to hand off a reference to a dictionary rather than build a duplicate of it.
Edge Performs a test for a rising or falling edge.
FindVariable Searches for a variable by text name and returns a variable value.
GetDefaultValue Returns a variable's default value.
GetReferencedValues Collect all dynamically referenced values in the call tree rooted at the parameter and return them in an array.
GetSessionContainers Returns an array of the names of tags that are "container" tags that exist at any level under the given context (parent) tag
GetSessionContainerTags Returns a dictionary of tag items below a given context (parent) tag
GetStructInfo Returns names and counts of all instantiated structures.
GetModuleContext Returns the context of a given module-in-context.
GetRetainedValue Given the name of a variable whose value was retained, this function will load the retained value from storage.
The function also provides the option of deleting the files holding that value.
GetTagMode Returns text or a structure to identify what kind of tag a given instance is.
GetValue Returns the current count of the values within an accumulator dictionary.
GetVariableText Returns information about the documentation of a variable.
GetVariableType Returns the type, BASEVALUE, stored within a variable.
GetVarMetadata Every variable object contains an embedded value. This function is used to retrieve those values.
HasMetaData Tests whether a given variable is a dictionary. Because the default behavior of most operands and functions on dictionaries is to return just the value of the dictionary’s root, this function provides the only means to determine whether a variable contains a dictionary.
Invalid Return Invalid Value. This function always returns an invalid value.
IsEqual Will return TRUE if the parameter values are equivalent, or if both are invalid.
IsDictionary A synonym for HasMetadata. Tests whether the parameter is a dictionary.
IsTagOperable Returns TRUE if the user is able to operate the selected tag from the Tag Browser using the right-click menu.
Latch Latch On or Off. This function allows a transient change of a variable to be captured. Its return value is determined by the rules listed in the comments section.
ListKeys Returns an array of all keys used within a dictionary. It is expected that this function will be used primarily in the context of metadata (extended information attached to a variable). ListKeys also enables you to discover what is in a dictionary.
ListVars Returns a list of variables.
LValue Left-hand Side Value. This function returns an indication of whether its argument can be used on the left-hand side of an assignment.
MakeNonPersistent Takes a variable and makes it not persistent.
MakeNonShared Takes a shared variable and makes it not shared.
MakePersistent Takes a variable and makes it persistent (static).
MakeShared Takes a variable and makes it shared.
MetaData If used with a variable which is not currently a dictionary, this command attached meta data to that variable, thereby creating a dictionary object. The primary purpose in this case is to provide a means of associating extended data with a variable.
NumSets Returns the number of statements that are currently active in setting a particular variable.
NumVariables Returns the number of variables in a module.
Parameter Returns the value of (or may assign a value to) a parameter of a module, specified by the index.
ParameterEdit Draws an interface to allow the user to choose how to edit a parameter. Used in tag widgets.
ColorParameterEdit ParameterEdit Wrapper - allow user to modify a color
DurationParameterEdit ParameterEdit Wrapper - allow user to set a time duration
MultiCheckboxParameterEdit Use this function to make any number of check boxes in a group.
NumericParameterEdit ParameterEdit Wrapper - allow user to modify a numeric value
TagParameterEdit ParameterEdit Wrapper - allow user to choose a tag
TextParameterEdit ParameterEdit Wrapper - allow user to enter a text value
TimestampParameterEdit ParameterEdit Wrapper - allow user to set a timestamp
UnTypedParameterEdit ParameterEdit Wrapper. Add control to a panel without defining the type.
PersistentSize Returns the size in bytes of a variable's persistent value size in the persistent value (.VAL) file.
PID Perform PID Controller Function. This function returns a control value to maintain a parameter at a given setpoint.
PType Returns the actual type of parameter at an index.
PTypeToggle (VTS Library) Parameter Setting Type Toggled Field. This module draws a beveled droplist or editfield with title that sets a tag or numeric value.
RootValue Retrieves the root value from a dictionary. This function will always attempt to return a value that is not itself a dictionary. If the value stored as the root of the given dictionary is also a dictionary, this function will return the root value from that second dictionary. Should all root values be other dictionaries (which would imply that the dictionary at the end of the chain must actually be an earlier dictionary) then RootValue will traverse the chain until it finds a root value which is an earlier dictionary (i.e. the end of the chain before it loops back) and will return that root value. This is the only situation where the command will return a dictionary as the result.
SetDefault Sets the default value for a variable.
SetVariableClass Sets the class number of a variable and returns its previous class number.
SetVariableText Sets the information about the documentation of a variable in the .SRC file.
SetVariableType Sets the data type for the variable, so that only values of that data type can be stored in the variable.
StaticSize Returns the size of a given variable, provided that the variable is static.
StrictlyEqual Will return TRUE if the parameter values are of the same type and also are equivalent, or if both are invalid.
StrictlyNotEqual Complement to StrictlyEqual.
Struct Returns a dictionary, using the provided parameters as keys.
Tag Returns a Tag value, which works like (and in place of) a Normalize value.
Toggle Returns its previous status value except when its parameter changes from a false to a true, in which case it changes its value.
ToggleVal Toggles between TRUE (1) and FALSE (0), once each given period.
TriggerCounter Returns a count of zero-to-non zero transitions during the current session.
Valid Returns true if the parameter is valid.
ValueType Returns the type of value passed to it.
Variable Accesses a variable by its text name. The return value is optional.
VariableClass Returns the class of a variable.
Watch Watches its parameters and returns true when any of their types or values change.
WatchArray Watches an array and returns true if any of its elements' types or values change.
WatchForTagChanges Watches for tag changes, either external or local. (Deprecated)
WatchTags Watches for tag changes, either external or local. (Use instead of WatchForTagChanges)
WCSubscribe Working Copy Subscribe. After this function has been called, any configuration change will result in the specified callback subroutine being called.
IsVICSession Returns TRUE to indicate that a call is being made from a VTScada Internet Client session.
NotifyVIC Sends a message to the VTScada Internet Client (VIC). The message sent depends on the parameter given to the function.
SetVicParms Sets parameters for the VTScada Internet Client.
VICInfo Provides information about the currently connected VTScada Internet Clients.
VICMessage Transmits a message to one or all currently connected VTScada Internet Client sessions. The message is displayed in a dialog box on the VIC computer.
ActiveWindow ActiveWindow returns the object value of the root module instance in the current active window.
Click Returns an indication of whether the mouse pointer is within a specified screen area and a particular button combination is being pressed.
Cls Clears the screen and sets its background color.
Coordinates Sets the VTScada screen coordinate limits (also called "world coordinates") used by the graphics functions.
CoordToPixel Takes a specified coordinate pair within a given window and returns the overall, onscreen pixel location.
Crop Modifies an existing image, producing a new one that displays a sub-section of the original.
CurrentWindow Returns the application window over which the mouse cursor currently rests.
DelPageFromApp Deletes a system page from an application.
FocusID Returns the focus ID of the object in a window that currently has the input focus.
GetXformRefBox Get Transform Reference Box. This function returns the reference box for any transform of a module.
LocCapture Capture Locator Input. This statement captures all subsequent input from the locator device and routes it to a specific window.
MoveWindow Will move a window to the specified coordinates.
ParentWindow Returns the object value of the nearest non-child window.
RootWindow Returns the object value of the root (original) module displayed in the same window.
SetCursor Sets the mouse cursor type for the window.
SetEditMode Sets the graphics edit mode for a window.
SizeWindow Changes the visible size of a window on the screen.
UnselectGraphics Will deselect all of the graphics in the specified window.
VStatus Returns the video board and screen characteristics for VTScada.
WinButton Windows native button.
WinComboCtrl Windows native "combo" control. A "combo" control is an enhanced form of drop list. Displays a child window containing a Windows combo control.
Window Opens a new window, starts a module inside, and eventually returns the module's value.
WindowClose Returns true if an attempt to close the window is made.
WindowOptions Alters the options on a window after it has been opened.
WindowSnapshot Creates an image file containing a screen capture of the specified window.
WinLocSwitch Returns the current status of the locator (mouse) buttons in a certain window and its ancestors.
WinLocWheel Returns TRUE when the mouse wheel is rolled while the mouse is over the specified window with the specified modifier key held down.
WinYLoc Returns the Y coordinate of the locator (mouse) in a window.
XLoc Returns the X window coordinate of the locator (mouse).
YLoc Returns the Y window coordinate of the locator (mouse).
GetXMLNodeArray Searches the result returned from XMLParse and returns an array of XMLNode values of a given type.
RemWSDL Disconnects a Realm from a WSDL file and the associated set of VTScada modules, cleaning up any resourced used by that web service.
SetWSDL Connects a Realm with a WSDL file and a set of VTScada modules to enable a web service interface.
XMLAddSchema Adds a schema to an XML Processor.
XMLCloneNode Clones an existing XMLNode, optionally adding additional members.
XMLCreateNode Creates a new XMLNode.
XMLDeleteMember Deletes a member from an XMLNode in-place.
XMLGetNode Returns an XMLNode from a tree.
XMLParse Parses the supplied XML using the specified XML Processor.
XMLProcessor Creates a new XML Processor.
XMLWrite Converts the instance of a type, as specified by XMLNodeTreeIn, into XML.