OSI/FTAM Programming Reference Manual

FTM Procedures
HP NonStop OSI/FTAM Programming Reference Manual—528611-001
4-68
FTM_END_GROUP_REQ_
FTM_END_GROUP_REQ_
This procedure allows you to signify the end of a group of FTAM requests.
error return value
INT
indicates the outcome of the call. For a list of defined values, see Appendix B,
NonStop FTAM Initiator Error Messages.
cepi input
INT:value
is the connection endpoint identifier (CEPI) used to identify the specific
association. Use the CEPI value returned from the FTM_INITIALIZE_REQ_
procedure for this association. For additional information on using the cepi
parameter, see the OSI/FTAM Programming Guide.
cepi is a required parameter.
tag input
INT(32):value
is for use in nowait mode only. Specify a unique value to identify this instance of
the procedure call. When the operation is complete, the MFM_AWAITIOX_
procedure returns the tag value, allowing your application to match the completion
with the correct instance of the procedure call. For details on the use of the tag
parameter, see the OSI/FTAM Programming Guide.
tag is an optional parameter.
Considerations
•
To successfully complete this procedure call, you must have previously called
FTM_BEGIN_GROUP_REQ_.
•
Because no values are returned on the F-END-GROUP response, no confirm
procedure is needed to retrieve data. You must, however, verify the success of the
F-END-GROUP primitive by calling APS_STATUS_ and determining that the
end-group confirm has been received. If the value of the APS_STATUS_ event-
code parameter is ZFTM-VAL-EVT-ENDGROUP-CNF, the end-group confirm has
been received.
•
You must issue an MFM_AWAITIOX_ call to complete the nowait I/O operation if
you set the nowait operating mode in the FTM_INITIALIZE_REQ_ call.
error := FTM_END_GROUP_REQ_ ( cepi ! I
, [ tag ] ) ; ! I