Verastream SDK .Net Reference
ScreenUPG Class Methods


For a list of all members of this type, see ScreenUPG members.

Public Methods
 NameDescription
Public MethodaddIScreenListenerEx Enables your application to receive various screen event notifications from the Screen object.  
Public MethodaddIStatusListener Enables your your application to receive status event notifications from the Screen object.  
Public MethodclearCapturedData Clears information from the captured data buffer.  
Public MethodClose Closes the current host session.  
Public MethodDisposeOverloaded.   
Public MethodfieldCount Returns the number of fields of the specified type.  
Public MethodfindField Searches the presentation space for the specified field beginning from the row and column position specified.  
Public MethodfindFieldEx Searches the presentation space for the specified field beginning from the index (field number) specified.  
Public MethodfindString Searches the presentation space for the specified text string starting from the specified start position. If found, it returns true and the start position of the string.  
Public MethodfindStringEx Searches the presentation space for the specified text string from the specified start position to the specified end position. If found, it returns true and the start position of the string.  
Public MethodgetCapturedBytesReturns the currently captured data as a byte array. The data capture facility allows you to save all information being sent by the host communications layer to the presentation space for later retrieval as a byte array or a String.

Depending on the type of terminal and type of host connection, this data may be in the 8-bit ASCII, 8-bit EBCDIC or 6-bit ALC character set.

 
Public MethodgetCapturedData Returns the currently captured data as a string. The data capture facility allows you to save all information being sent by the host communications layer to the presentation space for later retrieval as a byte array or a String. Depending on the type of terminal and type of host connection, this data may be in the 8-bit ASCII, 8-bit EBCDIC or 6-bit ALC character set.  
Public MethodgetCapturedJavaBytesReturns the currently captured data as a signed byte array. The data capture facility allows you to save all information being sent by the host communications layer to the presentation space for later retrieval as a byte array or a String.

Depending on the type of terminal and type of host connection, this data may be in the 8-bit ASCII, 8-bit EBCDIC or 6-bit ALC character set.

 
Public MethodgetColumns Returns the number of columns in the presentation space.  
Public MethodgetCursor Returns the current cursor position.  
Public MethodgetCursorColumn Returns the column of the current cursor position.  
Public MethodgetCursorRow Returns the row of the current cursor position.  
Public MethodgetDataCapture Returns the current state of the data capture facility.  
Public MethodgetDescriptionReturns a custom description for the instance of the Screen object if a description was created previously using setDescription.  
Public MethodgetExtPS Returns the specified portion of the presentation space in a string format.  
Public MethodgetgetText_Display Returns the current setting of the getText_Display property.  
Public MethodgetKeyboardLocked Returns the current state of the keyboard.  
Public MethodgetMaxDataCaptureLength Returns the current maximum buffer size for data captured using the data capture facility. The data capture facility allows you to save all information being sent to the presentation space by the host for later retrieval as a byte array or a string.  
Public MethodgetObjectVersion Returns the version number of the specified Screen object.  
Public MethodgetOIAContents Returns the data displayed in the OIA portion (status line) of the presentation space.  
Public MethodgetOIAText Returns the text of the OIA portion (status line) of the presentation space in a string format.  
Public MethodgetOperatorDisable Gets the current Operator Disabled status for MATIP sessions.  
Public MethodgetPeripheralControl Gets the current peripheral control state for UTS INT-1 sessions.  
Public MethodgetRows Returns the number of rows in the presentation space.  
Public MethodgetScreenType Returns the current host type.  
Public MethodgetString Returns the visible text from the specified location.  
Public MethodgetStringEx Returns the visible text from the specified location with attributes matching those specified by inAttr.  
Public MethodgetText Returns the text contents of the presentation space as a string.  
Public MethodisConnected Returns the state of the host/gateway connection.  
Public MethodisKeyboardLocked Returns the current state of the keyboard.  
Public MethodOpen Opens a host session.  
Public MethodOpenEx Opens a host session, waiting a specified time for the connection to be established before returning.  
Public MethodputString Copies a string of text to the specified position in the presentation space and returns the number of characters written.  
Public MethodputStringEx Copies a string of text to the specified position in the presentation space and returns the number of characters written.  
Public MethodRawDataTransmitWrites a string of characters directly to the host communications layer, without going through the presentation space. The Unicode characters are converted to bytes with the default encoding for the platform.

Depending on the type of terminal and type of host connection, this data may have to be in the 8-bit ASCII, 8-bit EBCDIC or 6-bit ALC character set.

 
Public MethodRawDataTransmitBytesOverloaded. Writes an array of bytes directly to the host communications layer, without going through the presentation space.

Depending on the type of terminal and type of host connection, this data may have to be in the 8-bit ASCII, 8-bit EBCDIC or 6-bit ALC character set.

In the case of ALC, you must have two leading placeholder characters and one trailing placeholder character in your buffer (i.e. nn mm "real data" zz).

 
Public MethodremoveIScreenListenerEx Removes the ScreenListener from the Screen object. The Screen object will no longer receive screen/status event notifications.  
Public MethodremoveIStatusListener Removes the StatusListener from the Screen object. The Screen object will no longer receive status event notifications.  
Public MethodsendKeysSends characters and special keys to the session. They are treated the same as if they were typed at the keyboard. Special keystrokes can be specified in HLLAPI format, which has a special code for each keystroke, such as "@E" for the host Transmit key, or Braces format, where the key name is surrounded by braces, such as "{Transmit}". See Key Codes for a complete list of codes for each host type. You can also use sendKeys to send text character strings to the session. Text is sent to the host or written to the presentation space at the current cursor location. For example, to send the text "logoff" followed by the Transmit key, inText would be "logoff@T". If you are sending a lot of text to the presentation space, however, it may be more efficient to use putString or putStringEx instead. If an invalid key sequence is detected, no characters or keys are sent. It is recommended that you follow every sendKey call with a call to one of the wait methods (for example, WaitForString , WaitHostQuiet, or WaitForCursor). This helps to ensure that the host has completed processing before your application moves on to the next step.  
Public MethodSendStatusOverloaded.  Sends a status message with option detail to screen.  
Public MethodsetCursor Sets the cursor position in the presentation space.  
Public MethodsetCursorColumn Sets the column of the cursor position.  
Public MethodsetCursorRow Sets the row of the cursor position.  
Public MethodsetDataCapture Turns the data capture facility on or off.  
Public MethodsetDataCaptureEx Turns the data capture facility on or off. In addition, turns on or off the suppression of updates to the presentation space.  
Public MethodsetDescription Creates a custom description for the instance of the Screen object.  
Public MethodsetgetText_Display Turns the getText_Display property on or off.  
Public MethodsetMaxDataCaptureLength Sets the maximum buffer size for data captured using the data capture facility. The data capture facility allows you to save all information being sent to the presentation space by the host for later retrieval as a byte array or a string.  
Public MethodsetOperatorDisable Attempts to set Operator Disabled status for MATIP sessions.  
Public MethodsetPeripheralControl Sets the Peripheral Control State for UTS INT-1 sessions. This advanced feature is for applications that want control over print activity.  
Public MethodwaitForCursor Waits for the cursor to appear at the specified position for a specified period of time.  
Public MethodwaitForString Waits for the specified text to appear at the specified position for a specified period of time.  
Public MethodwaitHostQuiet Waits for the host session to be idle for a specified period of time (in milliseconds). A session is considered to be "quiet" when there has been no activity in the host session for the specified amount of time. This is a synchronous call and does not return until the wait condition is satisfied. Otherwise, it times out after wtTime (specified in milliseconds).  
Top
Protected Methods
 NameDescription
Protected MethodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.  
Top
See Also