OSI/FTAM Programming Reference Manual

FTM Procedures
HP NonStop OSI/FTAM Programming Reference Manual—528611-001
4-10
Procedure Call Descriptions
Legend
Figure 4-1. Sample FTM Procedure Call Description
1 Procedure call name.
2 Description of procedure function.
Items 3 through 6 illustrate the syntax of the procedure, including all required and optional
parameters.
3 This indicates the type of value that the procedure returns. For the FTM
procedures, the variable type is always either “status” or “error.” HP notation for the
variable is either status or error. Possible ZAPS-VAL-STATUS-xxx values for
status are listed in Table B-1
on page B-2; possible ZAPS-ERR-xxx and
ZFTM-ERR-xxx error values are listed in Table B-2 on page B-4 and Table B-5
on page B-19.
4 This is the name of the procedure. It must appear in your program exactly as
shown, including the underscore characters. In C programming, all letters in the
name must be in uppercase.
1 FTM_BEGIN_GROUP_REQ_
2 This procedure allows you to request the start of a group of FTM procedures, which are then
processed and responded to as a group.
3 4 5 6
status := FTM_BEGIN_GROUP_REQ_ ( cepi ! I
, threshold ! I
, [ tag ] ); ! I
status return value
INT
indicates the outcome of the call . . .
7 cepi input
8 INT:value
9 is the connection endpoint identifier (CEPI) . . .
. . .
10 Considerations
. . .
11 Errors
. . .
12 Examples
. . .
VST0401.vsd