Carbon


HVolumeParam

Header: Files.h

struct HVolumeParam {
    QElemPtr qLink; 
    SInt16 qType; 
    SInt16 ioTrap; 
    Ptr ioCmdAddr; 
    IOCompletionUPP ioCompletion; 
    volatile OSErr ioResult; 
    StringPtr ioNamePtr; 
    SInt16 ioVRefNum; 
    SInt32 filler2; 
    SInt16 ioVolIndex; 
    UInt32 ioVCrDate; 
    UInt32 ioVLsMod; 
    SInt16 ioVAtrb; 
    UInt16 ioVNmFls; 
    UInt16 ioVBitMap; 
    UInt16 ioAllocPtr; 
    UInt16 ioVNmAlBlks; 
    UInt32 ioVAlBlkSiz; 
    UInt32 ioVClpSiz; 
    UInt16 ioAlBlSt; 
    UInt32 ioVNxtCNID; 
    UInt16 ioVFrBlk; 
    UInt16 ioVSigWord; 
    SInt16 ioVDrvInfo; 
    SInt16 ioVDRefNum; 
    SInt16 ioVFSID; 
    UInt32 ioVBkUp; 
    SInt16 ioVSeqNum; 
    UInt32 ioVWrCnt; 
    UInt32 ioVFilCnt; 
    UInt32 ioVDirCnt; 
    SInt32 ioVFndrInfo[8];
};
typedef HVolumeParam HVolumeParamPtr;

Field descriptions

qLink

A pointer to the next entry in the file I/O queue. (This field is used internally by the File Manager to keep track of asynchronous calls awaiting execution.)

qType

The queue type. (This field is used internally by the File Manager.)

ioTrap

The trap number of the function that was called. (This field is used internally by the File Manager.)

ioCmdAddr

The address of the function that was called. (This field is used internally by the File Manager.)

ioCompletion

A pointer to a completion routine to be executed at the end of an asynchronous call. It should be NULL for asynchronous calls with no completion routine and is automatically set to NULL for all synchronous calls. See IOCompletionProcPtr for information about completion routines.

ioResult

The result code of the function. For synchronous calls, this field is the same as the result code of the function call itself. To determine when an asynchronous call has actually been completed, your application can poll this field; it’s set to a positive number when the call is made and receives the actual result code when the call is completed.

ioNamePtr

A pointer to a pathname. Whenever a function description specifies that ioNamePtr is used—whether for input, output, or both—it’s very important that you set this field to point to storage for a Str255 value (if you’re using a pathname) or to NULL (if you’re not).

ioVRefNum

A volume specification (volume reference number, working directory reference number, drive number, or 0 for default volume).

filler2

Reserved.

ioVolIndex

An index for use with the PBHGetVInfo function.

ioVCrDate

The date and time of volume initialization.

ioVLsMod

The date and time the volume information was last modified. (This field is not changed when information is written to a file and does not necessarily indicate when the volume was flushed.)

ioVAtrb

The volume attributes.

ioVNmFls

The number of files in the root directory.

ioVBitMap

The first block of the volume bitmap.

ioAllocPtr

The block at which the next new file starts. Used internally.

ioVNmAlBlks

The number of allocation blocks.

ioVAlBlkSiz

The size of allocation blocks.

ioVClpSiz

The clump size.

ioAlBlSt

The first block in the volume map.

ioVNxtCNID

The next unused catalog node ID.

ioVFrBlk

The number of unused allocation blocks.

ioVSigWord

A signature word identifying the type of volume; it’s $D2D7 for MFS volumes and $4244 for volumes that support HFS calls.

ioVDrvInfo

The drive number of the drive containing the volume.

ioVDRefNum

For online volumes, the reference number of the I/O driver for the drive identified by ioVDrvInfo.

ioVFSID

The file-system identifier. It indicates which file system is servicing the volume; it’s zero for File Manager volumes and nonzero for volumes handled by an external file system.

ioVBkUp

The date and time the volume was last backed up (it’s 0 if never backed up).

ioVSeqNum

Used internally.

ioVWrCnt

The volume write count.

ioVFilCnt

The total number of files on the volume.

ioVDirCnt

The total number of directories (not including the root directory) on the volume.

ioVFndrInfo

Information used by the Finder.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)