Host Get Field Attributes

This Host Interface tool returns various field attributes for a given host connection, screen, and field.

Inputs

Host Connection

The name of the connection created by the Host Connect or the Host Connect Ex tool.

Screen

The name of a screen as defined in the host profile.

Field Name

The name of the field in the screen that is being queried by this tool.

Outputs

Start X

The position on the screen denoting the beginning X coordinate of the field.

Start Y

The position on the screen denoting the beginning Y coordinate of the field.

End X

The position on the screen denoting the ending X coordinate of the field.

End Y

The position on the screen denoting the ending Y coordinate of the field.

Length

The length of the field as calculated using the Start X, Start Y and End X, End Y parameters. Some fields may extend beyond a given line so both coordinates (x,y) are included when determining the length. Each coordinate may contain one character, so a field of n length could contain n characters.

Foreground Color

String denoting the background color of the field.

Background Color

String denoting the background color of the field.

Protected

A Boolean variable indicating whether or not the field is protected.

Bold

A Boolean variable indicating whether or not the text in the field is bolded.

Reverse Video

A Boolean variable indicating whether or not the field is displayed as reverse video.

Underlined

A Boolean variable indicating whether or not the field is underlined.

Blinking

A Boolean variable indicating whether or not the field is blinking.

Hidden

A Boolean variable indicating whether or not the field is hidden.

Exit Paths

Success

This path is taken if the field attributes are successfully retrieved.

Failure

This path is taken if the operation fails.