beautypg.com

Visara Master Console Center Scripting Guide User Manual

Page 247

background image

Appendix B Command Syntax

Scripting Guide

247

Command Command

Type

Description Syntax

BASEDIRECTORY

Variable

Obtains the base directory for the product.

BASEDIRECTORY()==>$DirectoryString

BLOCKSCAN

Console
Message

Enables up to 256 SCANB commands to execute
as a group.

BLOCKSCAN(%Wait,*Timeout[,$Array])…ENDB
LOCK

CHR

Variable

Returns the character whose value is the ASCII

code given.

CHR(%Number)==>$String

CLASSNAME

Misc.

Returns the class name for a class number

CLASSNAME(%Class])==>$ClassName

CLASSNUM

Misc. Returns

the

class

number for a class name

string.

CLASSNUM([$ClassName])==>%Class

CPUPOWER

Physical

Interface
Control

Switches a CPU’s power ON or OFF. CPUPOWER(%Port,%Operation)

DATE

Time

Converts a date string to a date value. DATE($DateString])==>%EpochSeconds

DEC

Variable

Subtracts one from a numeric variable’s value.

DEC%Variable

DECODE

Variable

Decodes a string.

DECODE ($String[,$Key]) ==>$Result

DIUNIT

Physical
Interface

Control

Check the status of a device connected to a DI
unit.

DIUNIT(%Port)==>%Status

DOUNIT

Physical

Interface

Control

Controls the device connected to a DO unit.

DOUNIT(%Port[,%Operation])==>%DOSwitch

ENCODE

Variable

Encodes a string.

ENCODE ($String[,$Key]) ==>$Result

END

Flow
Control

Ends the execution of the script thread.

END

ERRORMSG

Misc.

Returns the error message associated with the
error number.

ERRORMSG(%ErrNum)==>$ErrMsg