zModifyInfoByName

Modifies file status and metadata information for the given file object that is passed in by name.

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

Syntax

#include <zPublics.h>

STATUS zModifyInfoByName(
   Key_t        key,
   Xid_t        xid,
   NINT         nameSpace,
   const void  *path,
   QUAD         modifyInfoMask,
   NINT         sizeModifyInfo,
   NINT         infoVersion,
   const void  *modifyInfo);

Parameters

key

(IN) Specifies the file (as returned by zOpen or zCreate) whose metadata information will be modified.

xid

(IN) Specifies the transaction to which the request is bound. If there is no transaction, pass zNILXID.

nameSpace

(IN) Specifies the starting namespace for the path parameter. In addition to the normal namespace identifiers (zNSPACE_DOS | zNSPACE_MAC | zNSPACE_UNIX | zNSPACE_LONG | zNSPACE_DATA_STREAM | zNSPACE_EXTENDED_ATTRIBUTE), the nameSpace parameter can be augmented by ORing the following mode bits:

  • zMODE_UTF8

    The default character set for the path is Unicode; however, by ORing zMODE_UTF8, UTF-8 character strings can be used.

  • zMODE_DELETED

    Changes the name scanning to look for deleted files in the salvage system, which effectively purges the file.

  • zMODE_LINK

    If the last name in the path is a symbolic link, a junction, or a URL link, the scanning does not follow the link but acts on the link object itself.

path

(IN) Points to the path of the file object to be created. If the path is not fully qualified, the key must represent a directory for starting the path parsing. The default character set for the pathname is Unicode unless it is specified by the nameSpace parameter.

modifyInfoMask

(IN) Specifies a bit mask that identifies which fields of modifyInfoMask are to be modified (see Modify Info Mask Values). If a bit is set in this bit mask, the corresponding field of modifyFileInfo is used to modify the file.

sizeModifyInfo

(IN) Specifies the total size (in bytes) of the zInfo_s structure passed in to modifyInfo, which includes the size of the variable size portion that is used to store any variable sized pieces returned in the structure.

infoVersion

(IN) Specifies the version of the zInfo structure that is being used. For NetWare 6.x versions, there are two supported versions: zINFO_VERSION_A and zINFO_VERSION_B (which enables the ability to set directory quotas).

modifyInfo

(IN) Is a caller-supplied structure—either zInfo_s or zInfoB_s—that contains the requested information.

Return Values

zOK

The operation completed successfully.

non-0

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

Remarks

Only the metadata corresponding to the bits set in modifyInfoMask is modified. For any fields that are namespace-specific (such as the name), they are modified only in the namespace identified by nameSpace.

If an error occurs, the metadata for the file is not modified.

See Also

zGetInfo, zGetInfoByName, zInfoGetFileName, zModifyInfo