void hl_query_session_id (struct session_id *session_id_struct)

Verify that the specified session is available.

Call this subroutine once for each desired session at the start of an application using the Silicon Graphics 3270 HLLAPI.

void hl_init (struct init *init_struct)

Initialize the Silicon Graphics 3270 code at startup time.

Call this subroutine once, each time the Silicon Graphics 3270 HLLAPI application is started.

void hl_query_session_params (struct session_params *session_params_struct)

Determine the values of session characteristics that affect the operation of a Silicon Graphics 3270 HLLAPI application.

This subroutine can be called at any time after the Session ID has been determined. The Silicon Graphics 3270 HLLAPI deviates from the IBM 3270-PC API in that alternate screen sizes are supported. Extended Attributes are supported. Programmed Symbols are not supported.

void hl_query_session_cursor (struct session_cursor *session_cursor_struct)

Determine the current cursor position and type.

This subroutine must be called whenever the Silicon Graphics 3270 HLLAPI application needs to determine the current cursor position and type. Row and column addresses start at 0, not 1.

void hl_connect (struct connect *connect_struct)

Connect a Silicon Graphics 3270 HLLAPI application to an active 3270 Presentation Space.

This subroutine serializes access to keyboard and copy services. The routine must be called at the start of an Silicon Graphics 3270 HLLAPI application and normally is followed by a call to hl_reserve, which locks the keyboard, preventing operator input.

void hl_reserve (struct reserve *reserve_struct)

Causes 3270 emulator to disable keyboard input.

Normally, this subroutine is called immediately after hl_connect to prevent the intermingling of operator- and application-generated keyboard input.

void hl_send_key (struct send_key *send_key_struct)

Sends keystroke data from an Silicon Graphics 3270 HLLAPI application as an operator would enter it from a keyboard.

Used whenever the Silicon Graphics 3270 HLLAPI application wishes to send data to a host program. The Silicon Graphics 3270 HLLAPI deviates from the IBM specification by allowing an unlimited number of keystrokes to be encoded in the keystroke list.

void hl_release (struct release *release_struct)

Causes 3270 emulator to enable operator keyboard input.

If hl_reserve has been called, hl_release can be called to reenable keyboard input. The hl_disconnect subroutine also reenables keyboard input automatically.

void hl_disconnect (struct disconnect *disconnect_struct)

Disconnect a Silicon Graphics 3270 HLLAPI application from an active 3270 Presentation Space.

This subroutine serializes access to keyboard and copy string services. It must always be called prior to exiting the Silicon Graphics 3270 HLLAPI application code.

void hl_copy_data (struct copy_data *copy_data_struct)

Copy part or all of the data from the 3270 Presentation Space to the Silicon Graphics 3270 HLLAPI application data area or vice versa.

Called whenever data must be moved from the 3270 Presentation Space to the application data area. It is also used to update the 3270 Presentation Space. Only the 3270 device buffer format is supported.

void hl_read_oiag (struct read_oiag *read_oiag_struct)

Determine the current input inhibited state.

This subroutine determines when the 3270 Presentation Space is ready to accept input. It is designed to be used in a polled mode or blocked mode with a timeout. Each unit of time represents 10 milliseconds.

void hl_screen_status (struct screen_status *screen_status_struct)

Determine if any location on the screen has been updated.

This subroutine determines when the 3270 Presentation Space or Status Line has been updated. It eliminates the need to call hl_read_oiag and hl_copy_data to determine if any location on the screen has been updated. It also provides a flag that indicates that a structured field has been received from the host and is waiting to be read by the user application. Each unit of time represents 10 milliseconds.

void hl_copy_status (struct copy_status *copy_status_struct)

Provides the Silicon Graphics 3270 HLLAPI application with the ability to display and/or analyze all fields of the 3270 status line.

Used in error recovery or when the terminal display program is customer-supplied. If HL_NO_COPY is specified, the target_ptr is not used and it is assumed that stat_pointer from the map data structure will be used to point to the status line. If HL_COPY_TO_APPL is used, target_ptr must be defined.

void hl_start_msg (struct start_msg *start_msg_struct)

Allows the Silicon Graphics 3270 HLLAPI application to start Silicon Graphics Message Mode.

This subroutine must be invoked once prior to calling hl_read_msg or hl_write_msg. (CUT mode only)

void hl_stop_msg (struct stop_msg *stop_msg_struct)

Allows the Silicon Graphics 3270 HLLAPI application to terminate Silicon Graphics Message Mode.

Can be used to switch out of Silicon Graphics Message Mode. It need not be called when disconnecting, since hl_disconnect terminates Silicon Graphics Message Mode automatically.

void hl_read_msg (struct read_msg *read_msg_struct)

Read a Silicon Graphics Message Mode Protocol Data Units sent by the host.

This subroutine is typically called when the application expects the host to send Message Mode data rather then normal 3270 data. All returned data is encoded in 3270 Buffer Code. It is assumed that each screen is written using the 3270 Erase Write command and that each screen in “unformatted”. Each Set Buffer Address (0,0) is marked by an 0xff character inserted into the data stream. If HL_NO_COPY is specified, the data_ptr is not used. Instead, the mba_ptr from the map data structure is used into point to the 64 Kb Message Mode ring buffer. The map data pointer is initialized by calling hl_map_data. The application must manage its own offset into the ring buffer after initialization. If HL_COPY_TO_APPL is used, data_ptr must be defined.

void hl_read_sf (struct read_sf *read_sf_struct)

Read a 3270 Structured Field that has been sent by the host.

This subroutine is called whenever an Silicon Graphics 3270 HLLAPI application expects a Structured Field from the host other than the Read Partition Query and Outbound 3270DS. The application need not call this routine unless it has already detected a structured field pending using the flag word provided by hl_screen_status. Each call to hl_read_sf returns the contents of a Structured Field. (SDLC)

void hl_write_sf (struct write_sf *write_sf_struct)

Send a 3270 Structured Field to the host.

This subroutine is called whenever the Silicon Graphics 3270 HLLAPI application must send a 3270 Structured Field to the host other than Query Reply and Inbound 3270DS. The Structured Field can contain up to 4K bytes of data. (DFT mode only)

void hl_trace (struct session_id *session_id_struct)

Trace keyboard input and host output.

This routine is called whenever the Silicon Graphics 3270 HLLAPI application wants to trace all data passing through the Silicon Graphics 3270 HLLAPI. The trace data can be displayed by invoking /opt/3270/bin/display_3270trace.

void hl_map_data (struct map_data *map_data_struct)

Eliminate need to copy data from Silicon Graphics Presentation Space image into a local buffer provided by the Silicon Graphics 3270 HLLAPI application.

To minimize data copies and allow for different 3270 Presentation Space images, call once for each session at initialization time.

void hl_entry_point (struct entry_point *entry_point_struct)

Provide an entry point for user-supplied code enhancements to the IRIS 3270 Emulator.

This routine is called each time through the main processing loop for the IRIS 3270 Emulator. It is designed to provide an inline filter capability for user-specific needs allowing the filter routine to specify when the 3270 Presentation Space should be displayed for user viewing.