HP-UX SNAplus2 NOF Programmer's Guide

Writing NOF Applications
List Options For QUERY_* Verbs
Chapter 2112
list_options The position in the list of the first entry required:
• First entry in the list
• Entries starting from a specific named entry
• Entries starting from the next entry after a specific
named entry. (The name specified gives the
starting position according to the list ordering and
need not exist in the list; for example, if the list
contains entries NODEA, NODEB, NODED, NODEF, and
the application requests entries starting from the
first entry after NODEC, the first entry returned is
NODED.)
In addition, if the list_options parameter does not request starting
from the first entry, the name of a specific entry in the list is used to
indicate the starting position for the required entries.
The number of entries returned is the smallest of the following values:
• The num_entries parameter, if this is nonzero
• The maximum number of entries that the supplied data buffer can
hold
• The number of entries between the specified starting position and
the end of the list
In addition, the verb returns information about the total number of
entries available and the size of the buffer that would be required to
return all the entries at once. If the application has not yet received all
the information it requires, it can then issue further verbs to obtain the
remaining information.
These options enable the application to manage the information it
receives, as follows:
• To obtain a specific entry, it sets the index value to the name of that
entry, list_options to indicate “start from the named entry”,
buf_size to at least the size of a single entry, and num_entries to 1.
• To obtain a complete list a few entries at a time, it first sets
list_options to indicate “start from beginning of list”, and uses
either buf_size or num_entries to limit the amount of information
returned. If the returned values indicate that there is more
information available, it then issues another verb with
list_options indicating “start from the following entry” and sets