Class WriteVariableToLocation

A class that represents a VHI WriteVariableToLocation command.

Inheritance
object
Command
WriteVariableToLocation
Inherited Members
Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI.Command
Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll
Syntax
[Serializable]
public class WriteVariableToLocation : Command

Constructors

WriteVariableToLocation(string, int, int, int, bool, EchoType)

Constructs a new WriteVarToLocation command.

Declaration
public WriteVariableToLocation(string variable, int row, int column, int maxLength, bool erase, EchoType waitForEcho)
Parameters
Type Name Description
string variable

name variable containing value to be written
int row

the row of the location to be written to
int column

the starting column of the location to be written to
int maxLength

the maximum number of characters to write
bool erase

if true and if the length of the string contained in variable is less than maxLength, pad the value written with spaces until maxLength characters have been written.
EchoType waitForEcho

type of wait for echo to perform. See WriteVariableToTerminal(string, int, bool, EchoType) for values.
See Also

Properties

Column

Gets the column.

Declaration
public virtual int Column { get; }
Property Value
Type Description
int

the starting column of the location to be written to
See Also

Erase

Gets the erase flag.

Declaration
public virtual bool Erase { get; }
Property Value
Type Description
bool

if true and if the maxLength of the string contained in variable is less than maxLength, pad the value written with spaces until maxLength characters have been written.
See Also

MaxLength

Gets the max length.

Declaration
public virtual int MaxLength { get; }
Property Value
Type Description
int

the maximum number of characters to write
See Also

Name

Gets the command name.

Declaration
public override string Name { get; }
Property Value
Type Description
string

the command name
Overrides
See Also

Row

Gets the row.

Declaration
public virtual int Row { get; }
Property Value
Type Description
int

the row of the location to be written to
See Also

Variable

Gets the variable name.

Declaration
public virtual string Variable { get; }
Property Value
Type Description
string

name of variable to be read
See Also

WaitForEcho

Gets the wait for echo mode.

Declaration
public virtual EchoType WaitForEcho { get; }
Property Value
Type Description
EchoType

type of wait for echo to perform. See Transmit(string, EchoType).
See Also

See Also