SNMP Manager Programmer's Guide

SNMP Manager Programmer’s Guide–134249
xv
Notation Conventions
General Syntax Notation
The following list summarizes the notation conventions for syntax presentation in this
manual.
Nonitalic Letters. Nonitalic letters indicate keywords and reserved words. For example:
mibcomp [-numbers]
Some constructs, such as Manager Services library function names and predefined types,
must be encoded in mixed case. For example:
case VT_OPAQUE:
if (vbp->value_u.v_string.start_bp != (OCTET_T *)0)
EBufferClean(vbp->value_u.v_string));
lowercase italic letters. Lowercase italic letters indicate variable items that you supply.
Items not enclosed in brackets are required. For example:
buffer
[ ] Brackets. Brackets enclose optional syntax items. For example:
mibcomp [-numbers]
{ } Braces. A group of items enclosed in braces is a list from which you are required to
choose one item. For example:
mibcomp {@ automated-response-file-name | MIB-file-name}...
| Vertical Line. A vertical line separates alternatives in a list. For example:
mibcomp [-numbers | -statistics | -nametree | -readtree]
… Ellipsis. An ellipsis immediately following a syntax item indicates that you can repeat
that syntax item. For example:
mibcomp [-exclude MIB-module-name.MIB-object-name]...
An ellipsis within a source code example or typedef definition indicates that some
information has been omitted. For example:
typedef struct SNMP_PKT_S
{
...
UINT_16_T lcl_ident