Notation for management programming interfaces – HP Integrity NonStop J-Series User Manual

Page 11

Advertising
background image

A group of items enclosed in brackets is a list of all possible items that can be displayed, of
which one or none might actually be displayed. The items in the list can be arranged either
vertically, with aligned brackets on each side of the list, or horizontally, enclosed in a pair of
brackets and separated by vertical lines. For example:

proc-name trapped [ in SQL | in SQL file system ]

{ } Braces

A group of items enclosed in braces is a list of all possible items that can be displayed, of
which one is actually displayed. The items in the list can be arranged either vertically, with
aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and
separated by vertical lines. For example:

obj-type obj-name state changed to state, caused by
{ Object | Operator | Service }

process-name State changed from old-objstate to objstate
{ Operator Request. }
{ Unknown. }

| Vertical Line

A vertical line separates alternatives in a horizontal list that is enclosed in brackets or braces.
For example:

Transfer status: { OK | Failed }

% Percent Sign

A percent sign precedes a number that is not in decimal notation. The % notation precedes an
octal number. The %B notation precedes a binary number. The %H notation precedes a
hexadecimal number. For example:

%005400

%B101111

%H2F

P=%p-register E=%e-register

Notation for Management Programming Interfaces

This list summarizes the notation conventions used in the boxed descriptions of programmatic
commands, event messages, and error lists in this manual.

UPPERCASE LETTERS

Uppercase letters indicate names from definition files. Type these names exactly as shown. For
example:

ZCOM-TKN-SUBJ-SERV

lowercase letters

Words in lowercase letters are words that are part of the notation, including Data Definition
Language (DDL) keywords. For example:

token-type

!r

The !r notation following a token or field name indicates that the token or field is required. For
example:

ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. !r

!o

The !o notation following a token or field name indicates that the token or field is optional. For
example:

ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32. !o

Notation Conventions

11

Advertising
This manual is related to the following products: