Carbon


HFileParam

Header: Files.h

struct HFileParam {
    QElemPtr qLink; 
    SInt16 qType; 
    SInt16 ioTrap; 
    Ptr ioCmdAddr; 
    IOCompletionUPP ioCompletion; 
    volatile OSErr ioResult; 
    StringPtr ioNamePtr; 
    SInt16 ioVRefNum; 
    SInt16 ioFRefNum; 
    SInt8 ioFVersNum; 
    SInt8 filler1; 
    SInt16 ioFDirIndex; 
    SInt8 ioFlAttrib; 
    SInt8 ioFlVersNum; 
    FInfo ioFlFndrInfo; 
    SInt32 ioDirID; 
    UInt16 ioFlStBlk; 
    SInt32 ioFlLgLen; 
    SInt32 ioFlPyLen; 
    UInt16 ioFlRStBlk; 
    SInt32 ioFlRLgLen; 
    SInt32 ioFlRPyLen; 
    UInt32 ioFlCrDat; 
    UInt32 ioFlMdDat;
};
typedef HFileParam HFileParamPtr;

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).

ioFRefNum

The file reference number of an open file.

ioFVersNum

A file version number. This field is no longer used and you should always set it to 0.

filler1

Reserved.

ioFDirIndex

An index for use with the PBHGetFInfo function.

ioFlAttrib

File attributes. The bits in this field have these meanings

ioFlVersNum

A file version number. This field is no longer used and you should always set it to 0.

ioFlFndrInfo

Information used by the Finder.

ioDirID

A directory ID.

ioFlStBlk

The first allocation block of the data fork. This field contains 0 if the file’s data fork is empty.

ioFlLgLen

The logical end-of-file of the data fork.

ioFlPyLen

The physical end-of-file of the data fork.

ioFlRStBlk

The first allocation block of the resource fork.

ioFlRLgLen

The logical end-of-file of the resource fork.

ioFlRPyLen

The physical end-of-file of the resource fork.

ioFlCrDat

The date and time of the file’s creation, specified in seconds since midnight, January 1, 1904.

ioFlMdDat

The date and time of the last modification to the file, specified in seconds since midnight, January 1, 1904.


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