HP-UX SNAplus2 R7 NOF Programmer's Guide

Writing NOF Applications
List Options For QUERY_* Verbs
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 the index value to the name of the last entry received; this second verb then
returns the next section of the list. The application repeats this process until it has received all the required
entries.
2.7.2 Obtaining Summary or Detailed Information
Some QUERY_* verbs provide the option of returning either summary or detailed information about the specified
resources. For example, QUERY_LOCAL_LU can return just the LU name and LU alias (summary information)
or can also return additional information such as the LU address and session limit (detailed information). The
description of each QUERY_* verb in Chapter 3, NOF API Verbs indicates whether the verb includes the option of
returning summary or detailed information.
For the verbs that provide this option, the list_options parameter is used to indicate whether summary or detailed
information is required, as well as the starting position within the list. To specify these options, you combine two
values using a logical
OR operation (one value to specify the starting position in the list and one value to specify
whether summary or detailed information is required) and set the list_options parameter to the combination of these
two values. For verbs that do not provide this option, you simply set list_options to a single value to indicate the
starting position in the list.
79