Carbon


FCBPBRec

Header: Files.h

struct FCBPBRec {
    QElemPtr qLink; 
    SInt16 qType; 
    SInt16 ioTrap; 
    Ptr ioCmdAddr; 
    IOCompletionUPP ioCompletion; 
    volatile OSErr ioResult; 
    StringPtr ioNamePtr; 
    SInt16 ioVRefNum; 
    SInt16 ioRefNum; 
    SInt16 filler; 
    SInt16 ioFCBIndx; 
    SInt16 filler1; 
    SInt32 ioFCBFlNm; 
    SInt16 ioFCBFlags; 
    UInt16 ioFCBStBlk; 
    SInt32 ioFCBEOF; 
    SInt32 ioFCBPLen; 
    SInt32 ioFCBCrPs; 
    SInt16 ioFCBVRefNum; 
    SInt32 ioFCBClpSiz; 
    SInt32 ioFCBParID;
};
typedef FCBPBRec FCBPBPtr;

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

ioRefNum

The file reference number of an open file.

filler

Reserved.

ioFCBIndx

An index for use with the PBGetFCBInfo function.

filler1

Reserved.

ioFCBFlNm

The file ID.

ioFCBFlags

Flags describing the status of the file. The bits in this field that are currently used have the following meanings:

ioFCBStBlk

The number of the first allocation block of the file.

ioFCBEOF

The logical end-of-file.

ioFCBPLen

The physical end-of-file.

ioFCBCrPs

The position of the file mark.

ioFCBVRefNum

The volume reference number.

ioFCBClpSiz

The file clump size.

ioFCBParID

The file’s parent directory ID.

The low-level HFS function PBGetFCBInfo uses the file control block parameter block defined by the FCBPBRec data type.


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