zZIDDelete

Deletes the file designated by the specified ZID.

Service:File System Services (64-Bit)
Version:OES 2

Syntax

#include <zPublics.h>

STATUS zZIDDelete(
   Key_t        key,
   Xid_t        xid,
   VolumeID_t  *volumeID,
   Zid_t        zid, 
   NINT         deleteFlags);

Parameters

key

(IN) Specifies who is opening the file. If the volume ID is not supplied, the key identifies which volume to use.

xid

(IN) Specifies that any deletes that are part of the given transaction are not completed until the transaction is committed. For no transaction, set to zNILXID.

volumeID

(IN) Points to the GUID of the volume on which to search for the ZID. If NULL, the key parameter is used to identify the volume.

zid

(IN) Specifies the ZID of the file to be opened.

deleteFlags

(IN) Specifies a bit mask that identifies specific actions that are to take place on the file object that is being deleted.

Return Values

zOK

The operation completed successfully.

non-0

An error occurred (see Section 4.1, Return Values for a description).

Remarks

zZIDDelete works only with files and directories. It does not work with extended attributes or data streams.

If the salvage feature is enabled, delete is more like a rename operation that puts the file object in a state where its storage can be reused but the file object itself is no longer visible to naming (unless zMODE_DELETED is set in the nameSpaceID).

See Also

zOpen, zZIDOpen, zZIDRename, zZIDRename2