zinfo_t

Contains detailed information about a file object.

Service:

Defined In:fshooks.h

Syntax

  typedef struct 
  {
     uint32_t   version;
     size_t     totalBytes;
     size_t     nextByte;
     uint32_t   padding;
     uint64_t   retMask;
     
     struct     {  } std;
  
     struct     {  } storageUsed;
  
     int        primaryNameSpaceID;
     off_t      nameStart;
  
     struct     {   } names;
  
     struct     {   } time;
  
     struct     {   } id;
  
     struct     {   } blockSize;
  
     struct     {   } count;
  
     struct     {   } dataStream;
  
     struct     {   } extAttr;
  
     struct     {   } deleted;
  
     struct     {   } macNS;
  
     struct     {   } unixNS;
  
     volid_t    volumeID;
     userid_t   ndsObjectID;
     uint32_t   volumeState;
     uint32_t   nameSpaceMask;
  
     struct     {   } features;
  
     size64_t   maximumFileSize;
     size64_t   totalSpaceQuota;
     size64_t   numUsedBytes;
     size64_t   numObjects;
     size64_t   numFiles;
     uint32_t   authModelID;
     size_t     dataShreddingCount;
  
     struct     {   } salvage;
  
     struct     {   } comp;
  
     struct     {   } pool;
  
     uint32_t   extAttrUserFlags;
     uint8_t    variableData[1];
  } zinfo_t;

Fields

version: Specifies the version of the structure. Because this structure will need to change in the future, the version field will identify the particular structure being used.
totalBytes: Specifies the total number of bytes in fixed and variable data sections. Both sections are used so that the fixed area can grow without breaking older code pieces.
nextByte: Specifies the next byte to use in the variable area.
padding: Specifies some empty space.
retMask: Returns a bit mask of fields actually returned.
std: Specifies the standard set of file information. See std.
storageUsed: Returns information about the bytes a file is using to store its information (data and metadata). See storageUsed. Ignored by zModifyInfo.
primaryNameSpaceID: Specifies the name space used when the file was created. Names in the other name spaces are derived from the version of the file name in the primary name space.
nameStart: Specifies an index to the name. Ignored by zModifyInfo.
names: Returns information about the number of names in the variable data area. Ignored by zModifyInfo
time: Returns the UTC times when the file object was first created, last archived, last modified, last accessed, and the last time the metadata was modified. See time.
id: Returns the eDirectory object IDs of the file object’s current owner, last archiver, last modifier, and last metadata modifier. See id.
blockSize: Returns size and sizeShift. Ignored by zModifyInfo.
count: Returns open and hardLink. Ignored by zModifyInfo.
dataStream: Returns information about the number of data streams owned by the file object. Ignored by zModifyInfo.
extAttr: Returns information about the extended attributes for the file object. Ignored by zModifyInfo.
deleted: Returns the time and ID the file is deleted. See deleted.
macNS: Returns information about the Macintosh name space. If the Macintosh name space is not enabled on the volume, this structure is ignored. See macNS.
unixNS: Returns information about the UNIX name space. If the UNIX name space is not enabled on the volume, this structure is ignored. See unixNS.
volID: Specifies the number assigned to the volume. Ignored by zModifyInfo.
ndsObjectID: Specifies the eDirectory object ID for the volume.
volumeState: Specifies the state of the volume. For possible values, see Section 30.8.9, Volume States. Ignored by zModifyInfo.
nameSpaceMask
features: Returns information about volume attributes. See features.
maximumFileSize: Specifies the maximum of bytes that a file can consume on this volume. Ignored by zModifyInfo.
totalSpaceQuota: Specifies the maximum number of bytes that have been allocated for the volume.
numUsedBytes: Specifies the number of bytes in use on the volume. Ignored by zModifyInfo.
numObjects: Specifies the number of file objects currently on the volume. Ignored by zModifyInfo.
numFiles: Specifies the number of files currently on the volume. Ignored by zModifyInfo.
authModelID: Specifies the ID of the authentication model. Ignored by zModifyInfo.
dataShreddingCount: Specifies the number of cycles the volume is scheduled for shredding deleted and purged files.
salvage: Returns information about salvageable files. See salvage.
comp: Returns information about compressed files. Ignored by zModifyInfo.
pool: Specifies information about the pool the volume belongs to. See pool.
extAttrUserFlags: Specifies an arbitrary value that is set by the user. This field only applies to extend attributes and has no particular significance to the file system.
variableData: Specifies additional data space, which is allocated by the caller, to be used for all returned variable length optional data. Ignored by zModifyInfo.

Remarks

The zInfo_t structure must be preallocated by the caller. It contains a fixed portion for fixed size data and a variable portion to contain variable size data indexed to by the fixed portion. This variable length field is ignored by zModifyInfo.

zModifyInfo modifies only the fields identified by the bits set in the modifyInfoMask parameter. All other structure data that is not specified in the modifyInfoMask is ignored.