HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_DIRECTORY_ENTRY
3.107.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 supplied buffer.
total_buf_size
Returned value indicating the size of buffer that would have been required to return all the list information
requested. A value greater than
buf_size indicates that not all the available entries were returned.
num_entries
Number of entries returned in the data buffer.
total_num_entries
Total number of entries available. A value greater than num_entries indicates that not all the available entries
were returned.
Each entry in the data buffer consists of the following parameters:
directory_entry_summary.overlay_size
The size of the returned
directory_entry_summary 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
directory_entry_summary structure
in turn, it must use this value to move to the correct offset for the next data structure, and must not use the
C
sizeof() operator. This is because the size of the returned overlay may increase in future releases of
SNAplus2; using the returned overlay size ensures that your application will continue to work with future
releases.
directory_entry_summary.resource_name
Fully qualified name of the resource. The name is a 17-byte EBCDIC string, padded on the right with
EBCDIC spaces. It consists of a network ID of 1–8 A-string characters, an EBCDIC dot (period) character,
and a network name of 1–8 A-string characters
directory_entry_summary.resource_type
Type of the resource. This is one of the following:
AP_ENCP_RESOURCE
End node or LEN node
AP_NNCP_RESOURCE
Network node
AP_LU_RESOURCE
LU
directory_entry_summary.description
A null-terminated text string describing the directory entry, as specified in the definition of the directory entry.
directory_entry_summary.real_owning_cp_type
This parameter applies only if the local node is a Network Node or a Branch Network Node; it is reserved
otherwise.
Specifies whether the real CP that owns the resource identified by this directory entry is the parent resource
or another node. This is one of the following:
394