HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_TN3270_ACCESS_DEF
If a port number is specified, start at the session immediately following the session with the specified
port number. If no port number is specified, start at the first session for the specified client address.
The list is ordered by client address and then by port number for each user. For more information about how
the list is ordered and how the application can obtain specific entries from it, see Section 2.7,
List Options
For QUERY_* Verbs.
default_record
Specifies whether the requested entry (or the entry to be used as an index into the list) is the default record.
To query the default record, which is used by any TN3270 user not explicitly identified by a TCP/IP address,
specify
AP_YES. In this case, the client_address parameter is reserved.
To query a normal TN3270 user record, specify AP_NO.
client_address
The TCP/IP address of the TN3270 user for whom information is required, or the name to be used as an
index into the list of users. This parameter is a string of 1–64 characters, followed by a null character; it is
ignored if list_options is set to AP_FIRST_IN_LIST.
The address can be specified as a dotted-decimal IP address (such as 193.1.11.100), as a fully qualified
name (such as newbox.this.co.uk), or as an alias (such as newbox).
port_number
To return information starting with a specific session for the specified user, set this parameter to the TCP/IP
port number defined for that session. To return information starting at the first session for the specified user,
set this parameter to zero.
3.160.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 buf_size.
total_num_entries
Total number of entries that could have been returned. This may be higher than num_entries.
num_entries
The number of entries actually returned. The last entry may be incomplete; this is indicated by the
last_user_incomplete parameter.
num_init_sessions
If the port_number parameter was set to a nonzero value, so that the information for the first user in the list
does not start with the user’s first session, this parameter indicates the number of session structures for this
user that are included in the returned data. Otherwise, this parameter is not used.
num_last_sessions
If the last_user_incomplete parameter indicates that the data for the last user is incomplete, this parameter
indicates the number of session structures for this user that are included in the returned data. Otherwise, this
parameter is not used.
671