OSI/FTAM Programming Reference Manual

FTM Procedures

HP NonStop OSI/FTAM Programming Reference Manual—528611-001

4-70

FTM_ERASE_REQ_

This procedure allows you to request erasure of the contents of the specified

file-access data unit (FADU) in the previously selected and opened file.

status return value

INT

indicates the outcome of the call. For a list of possible ZAPS-VAL-STATUS-xxx

values, see Table B-1 on page B-2.

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.

fadu-id input

INT .EXT:ref:(ZFTM-DDL-FADU-ID)

specifies the target FADU for an operation. This value depends on the document

type of the file. Valid values are the following:

ZFTM-VAL-FADUID-FIRST for the ZFIRSTLAST field. This value specifies the

beginning of the first FADU after the root FADU and applies only to FTAM-1

and FTAM-3 document types.

ZFTM-VAL-FADUID-BEGIN for the ZBEGINEND field. This value specifies the

beginning of the root node and applies only to FTAM-2 document types.

fadu-id 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.

status := FTM_ERASE_REQ_ ( cepi ! I

, fadu-id ! I

, [ tag ] ) ; ! I