zGetInfo

Returns file status and metadata information for the given file object.

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

Syntax

#include <zPublics.h>

STATUS zGetInfo(
   Key_t   key,
   QUAD    getInfoMask,
   NINT    sizeRetGetInfo,
   NINT    infoVersion,
   void   *retGetInfo);

Parameters

key

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

getInfoMask

(IN) Specifies the information to be returned (see Get Info Mask Values).

sizeRetGetInfo

(IN) Specifies the total size (in bytes) of the zInfo_s structure passed in as the retGetInfo parameter, 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. zINFO_VERSION_B enables the ability to obtain directory quotas.

retGetInfo

(OUT) Is a caller-supplied structure—either zInfo_s or zInfoB_s—in which the requested information is returned. If it isNULL, no information about this file or directory object is returned.

Return Values

zOK

The operation completed successfully.

non-0

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

Remarks

If zERR_BUFFER_TOO_SMALL is returned, all of the fixed-length data is returned, but some of the variable-length data might not be returned because the buffer did not have enough room for all of the requested variable-length data. Call zGetInfo again with a larger buffer.

All of the variable-length data is indexed from the fixed portion of the structures. If the data is filled in, the index to it is filled in. If the data does not fit, the index to it is set to zero.

See Also

zGetFileMap, zModifyInfo