Method Name |
Description |
Return |
AddKey(long cmd,
long key, boolean shift, boolean ctl, boolean alt) |
Add an entry to the current key map. If
the key combination already exists it will be overwritten.
The cmd values are
defined in the CommandIDs section of the type library and may be
viewed by an object browser. The key values are those
defined by Microsoft as virtual key codes, such as VK_RETURN. |
void |
CaptureStart(String fileName) |
Start capture screen data to fileName |
long non-zero if error |
CaptureStop() |
Stop capture |
void |
ClearCapture() |
Clears capture file and any captured data in
memory |
void |
Connect(String hostName) |
Connect to hostName. If the hostName parameter is just a name then the control will fire a GetHostInfo event to resolve the IP address
etc. The actual result (connect confirm or connect reject) is
indicated either on a subsequent GetStatus call or via an
event.
The hostName can be a special case of the
character "+" which simulates a connection and sets the
connected status. This is useful for DataStream mode (see
InputData).
If the hostName parameter is a string then
it must provide the required host details, as a string with comma
separated values (see Host
Definition Format for details). |
long non-zero if error |
Copy() |
Clipboard copy |
void |
CopyTable() |
Clipboard copy as comma separated table
data |
void |
Cut() |
Clipboard cut |
void |
DeleteInDisplay() |
Delete character at the current cursor position and shift data left up to end
of field |
void |
DeleteInLine() |
Delete character at the current cursor position and shift data left up to end
of line |
void |
DeleteLine() |
Delete current row |
void |
Disconnect() |
Disconnect from host. If connected, a disconnected event will be fired when the
connection is terminated. |
long non-zero if error |
Display(String textString) |
Display textString
at current cursor |
void |
DisplayFF() |
Display a FF at current cursor
position |
void |
DisplayLF() |
Display a LF at current cursor
position |
void |
DisplaySOE() |
Display an SOE at current cursor
position |
void |
DisplayTab() |
Display an Tab at current cursor
position |
void |
DuplicateLine() |
Duplicate current row |
void |
EraseCharacter() |
Erase character at current cursor
position |
void |
EraseDisplay(boolean eraseCompletely) |
Erase the screen from cursor position or
completely if eraseCompletely is
true. |
void |
EraseEOF() |
Erase to end of field |
void |
EraseField() |
Erase all current field |
void |
EraseLine() |
Erase to end of line |
void |
EraseUnprotected() |
Erase unprotected data to end of
field |
void |
FindKey(long key, boolean shift, boolean ctl, boolean
alt) |
Find the specified key combination in the key
map and return the corresponding command id if found. |
long non-zero value of assigned command if
found |
FindText(String pTextString) |
Searches for the specified string on the screen
from the current cursor position to the end of display. The string
to be searched for must be contained on one screen line and is
specified by textString, a null
terminated string. The search is case
sensitive and, if the find is successful, the cursor is repositioned
to the first character of the found string. |
long non-zero if error |
GetAttribute() |
Get the screen attribute at current
cursor |
long attribute flags |
GetCmdName(long cmd) |
Return the command name for a specific command
id |
String cmdString |
GetColor(long* pForeColor, long*
pBackColor) |
Get the foreground and background color indices
at the current cursor |
void |
GetCursor(long* pRow, long* pCol) |
Get current cursor row and column (note you can
also access termRow and termColumn directly). |
void |
GetFieldText(long maxBytes) |
Get text from screen field at current cursor .
The cursor must be previously set to the required start position and
then this method copies the screen data from that position up to the
end of the screen field into the returned string. |
String foundString |
GetKey(long index, long* cmd, long* key, long* shift,
long* ctl, long* alt) |
Get the entry in the key map specified key by
index. If index is valid, the
corresponding command and key modifier information is returned. This
is useful for iterating through the key map, starting at index 0
until the call returns FALSE. |
Boolean
TRUE if index is
valid |
GetKeyName(long key, boolean shift, boolean ctl,
boolean alt) |
Get the name of the key corresponding to the
specified key code and modifier flags. |
String keyName |
GetRowText(long row, long startCol, long
columns) |
Get text from the screen row at the specified position. This
function call copies the screen data from that position up to the
end of the row into the returned string.
For T27, if row is 1 greater than the number of screen rows data
is retrieved from the status line.
|
String foundString |
GetSelectionStartEnd(long* pStartRow, long* pStartCol, long*
pEndRow, long* pEndCol, long* blockMode) |
Get the start and end row and column positions
of selected screen area (all zeroes if no current
selection) |
long |
GetStatus(long* pConnected, long*
pMsgArrived) |
Returns the status of the host
connection.
pConnected has one of the following values:
0 =
disconnected 1 = connecting 2 = connected 3 =
disconnecting
The pMsgArrived parameter is set to 1 if a new
message has arrived since the last call to GetStatus |
void |
GetStatusFlags() |
Get current status flags, defined as
follows:
STATUS_CONNECTED = 0x0001 STATUS_MSG_ARRIVED = 0x0002 STATUS_KEYBD_LOCKED= 0x0004 STATUS_MSG_WAITING = 0x0008 STATUS_SELECTED =
0x0010 |
short status flags |
GetText(long startRow, long startCol, long endRow, long
endCol) |
Get text off the screen from the specified rows
into the returned string. |
String foundString |
InputAttention() |
Assume an attention message has been
sent from the
host |
void |
InputData(String textString) |
Display textString, at the current cursor position interpreting the textString as a data stream from the
host |
void |
InsertInDisplay() |
Insert character at the current cursor position and shift data right up to end
of field |
void |
InsertInLine() |
Insert character at the current cursor position and shift data right up to end
of line |
void |
InsertLine() |
Insert new row at current cursor |
void |
LineSwapDown() |
Swap current row with row below |
void |
LineSwapUp() |
Swap current row with row above |
void |
LoadProperties(String fileName, long index) |
Load the terminal properties from the
settings file, for terminal number index. (ActiveX control
only) |
long |
MoveBackspace() |
Backspace the cursor |
void |
MoveBackTab() |
Tab backwards |
void |
MoveDown() |
Move the cursor down |
void |
MoveHome () |
To the home position |
void |
MoveLeft() |
Move the cursor left |
void |
MoveRight() |
Move the cursor right |
void |
MoveReturn() |
Move the cursor to start of next row |
void |
MoveScrollUp() |
Scroll the screen up one row |
void |
MoveTab() |
Tab forwards |
void |
MoveTo(long row, long col) |
Move the cursor to given row/column |
void |
MoveToEOF() |
Move to end of current field |
void |
MoveToLineBegin() |
Move to start of row |
void |
MoveToLineEnd() |
Move to end of row data |
void |
MoveToUnprotected() |
Move to next unprotected position |
void |
MoveUp() |
Move the
cursor up |
void |
NextPage() |
Move cursor up |
void |
NextRecall() |
Display next entry from command recall
list |
void |
Paste() |
Clipboard paste |
void |
PreviousPage() |
Select previous terminal page |
void |
PreviousRecall() |
Display previous entry from command recall
list |
void |
PrintCancel() |
Cancel print operation |
void |
PrintEject() |
Terminate current print operation and close
spool document |
void |
PrintFromSOE() |
Print the screen up to the current cursor
position |
void |
PrintPageSetup() |
Invoke the page setup common dialog |
void |
PrintScreen() |
Print the screen |
void |
PrintScreenData() |
Print the screen as transparent data |
void |
PrintSelected() |
Print the selected text |
void |
PrintToFile() |
Cause further printing to be sent to a disk
file(s) |
void |
PutText(long startRow, long startCol, long endRow, long endCol, String
textString, boolean spacePad) |
Display textString at the specified position. If
the text string does not occupy all the specified area then setting
the spacePad parameter to true causes the remainder to
be space filled. For
T27, if row is 1 greater than the number of screen rows data
is displayed on the status line.
|
void |
RemoveKey(long cmd,
long key, boolean shift, boolean ctl, boolean alt) |
Remove an entry from the current key map.
If cmd is zero the key combination
will be removed regardless of the assigned command. See AddKey
for comments on the cmd and key values. |
boolean TRUE if successfuly removed |
ResetTerminal() |
Resets the terminal including all settings
properties that have been changed |
void |
Resize(long width, long height) |
Resize control window (ActiveX only) |
void |
ResumeInput() |
Allow host input |
void |
RollDown() |
Roll screen down one row |
void |
RollUp() |
Roll screen up one row |
void |
SaveProperties(String fileName, long index) |
Save the terminal properties to the
settings file, for terminal number index. (ActiveX
control only) |
long |
SelectDown() |
Extend text selection downwards |
void |
SelectLeft() |
Extend text selection left |
void |
SelectRight() |
Extend text selection right |
void |
SelectUp() |
Extend text selection upwards |
void |
SendFKey(long keyNumber) |
Send a function key to the host (UTS
only) |
long non-zero if error |
SendMsgWait() |
Send a MsgWait (break) to the host (UTS) or a
Specify to the host (T27) |
long non-zero if error |
SendText(String pTextString) |
Send a text message directly to the host. Note
that the screen is not updated by this function call. |
long non-zero if error |
ShowGraphics() |
Display graphics screen, if available |
void |
ShowText() |
Display text screen |
void |
SnapScreenToCapture() |
Snap the screen data to capture file, if
capture open |
void |
StopInput() |
Stop host input (use ResumeInput
later) |
void |
TraceStart(String fileName) |
Start trace. If fileName is a null string ("")
then a file name is generated of the form ProductLognnn.txt. |
void |
TraceStop(bool viewFile) |
Stop trace. If viewFile is true then a prompt to
view the
trace file is displayed. |
void |
UnlockKeyboard() |
Unlock the keyboard, allowing keyboard
input |
void |
Wait(long timeout) |
Wait for the screen to be updated by the host.
Returns true if updated or false if timeout expired.
Note: The
wait functions are mostly useful when creating scripts (eg VBscript)
which cannot handle events. |
boolean |
WaitConnected(bool connected, long timeout) |
Wait to be connected (connected = true) or disconnected (connected = false). Returns false if
timeout expired. |
boolean |
WaitScreenText(short row, short col, String text, long
timeout) |
Wait for the screen at row/col to be set to text by the host. Note that setting both row and col to
zero (0) requests to search the whole screen for text. Returns false if timeout
expired.
For T27, if row is 1 greater than the number of screen rows data
is checked on the status line.
|
boolean |
Xmit() |
Simulate xmit key being pressed which initiates
the sending of data from the screen to the host. The actual data
transmitted depends upon the terminal type, the control page
setting, the current cursor position and the start of entry position.
Typically a UTS screen will be in XMIT VAR mode which means that all
unprotected data between the SOE character or home position and the
current cursor position is to be transmitted. |
long non-zero if error |