HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_TN3270_ASSOCIATION
A pointer to a data buffer that SNAplus2 will use to return the requested information.
buf_size
Size of the supplied data buffer.
num_entries
Maximum number of associations for which data should be returned. To request data for a specific association
rather than a range, specify the value
1. To return as many entries as possible, specify 0; in this case, SNAplus2
will return the maximum number of entries that can be accommodated in the supplied data buffer.
list_options
The position in the list of associations from which SNAplus2 begins to return data. Specify one of the
following values:
AP_FIRST_IN_LIST
Start at the first entry in the list.
AP_LIST_INCLUSIVE
Start at the entry specified by the display_lu_name parameter.
AP_LIST_FROM_NEXT
Start at the entry immediately following the entry specified by the display_lu_name parameter.
display_lu_name
Name of the display LU for which association information is required or the name to be used as an index
into the list of associations. The display LU name is an EBCDIC string padded on the right with EBCDIC
spaces. This parameter is ignored if list_options is set to AP_FIRST_IN_LIST.
3.161.3 Returned Parameters: Successful Execution
If the verb executes successfully, SNAplus2 returns the following parameters:
primary_rc
AP_OK
buf_size
Length of the information returned in the buffer.
total_buf_size
Returned value indicating the size of buffer that would have been required to return all the list information
requested. This may be higher than the value supplied for the buf_size parameter.
num_entries
The number of entries actually returned.
total_num_entries
Total number of entries that could have been returned. This may be higher than the value supplied for the
num_entries parameter.
Each entry in the data buffer consists of the following:
tn3270_association.overlay_size
The size of the returned
tn3270_association structure (and therefore the offset to the start of the next entry in
the data buffer).
When your application needs to go through the returned buffer to find each
tn3270_association structure in
turn, it must use this value to move to the correct offset for the next data structure, and must not use the
675