Legacy Document

Inside Macintosh: Files /

Chapter 2 - File Manager / File Manager Reference

Low-Level HFS Routines / Accessing Information About Files and Directories

PBHGetFInfo

You can use the PBHGetFInfo function to obtain information about a file.

FUNCTION PBHGetFInfo (paramBlock: HParmBlkPtr; async: Boolean): 
                        OSErr;

paramBlock

A pointer to a basic HFS parameter block.

async

A Boolean value that specifies asynchronous (TRUE) or synchronous (FALSE) execution.

-->	ioCompletion	ProcPtr	A pointer to a completion routine.
<--	ioResult	OSErr	The result code of the function.
<->	ioNamePtr	StringPtr	A pointer to a pathname.
-->	ioVRefNum	Integer	A volume specification.
<--	ioFRefNum	Integer	A file reference number.
-->	ioFDirIndex	Integer	An index.
<--	ioFlAttrib	SignedByte	The file attributes.
<--	ioFlFndrInfo	FInfo	Information used by the Finder.
<->	ioDirID	LongInt	On input, a directory ID; on output, a file ID.
<--	ioFlStBlk	Integer	The first allocation block of the data fork.
<--	ioFlLgLen	LongInt	The logical end-of-file of the data fork.
<--	ioFlPyLen	LongInt	The physical end-of-file of the data fork.
<--	ioFlRStBlk	Integer	The first allocation block of the resource fork.
<--	ioFlRLgLen	LongInt	The logical end-of-file of the resource fork.
<--	ioFlRPyLen	LongInt	The physical end-of-file of the resource fork.
<--	ioFlCrDat	LongInt	The date and time of creation.
<--	ioFlMdDat	LongInt	The date and time of last modification.

DESCRIPTION

If the value of ioFDirIndex is positive, the PBHGetFInfo function returns information about the file whose directory index is ioFDirIndex on the volume specified by ioVRefNum in the directory specified by ioDirID. You should call PBHGetFInfo just before PBHSetFInfo, so that the current information is present
in the parameter block.

Note

If a working directory reference number is specified in ioVRefNum, the File Manager returns information about the file whose directory index is ioFDirIndex in the specified directory.

If the value of ioFDirIndex is negative or 0, the PBHGetFInfo function returns information about the file having the name pointed to by ioNamePtr on the volume specified by ioVRefNum. If the file is open, the reference number of the first access path found is returned in ioFRefNum, and the name of the file is returned in ioNamePtr (unless ioNamePtr is NIL).

ASSEMBLY-LANGUAGE INFORMATION

The trap macro for PBHGetFInfo is _HGetFileInfo.

RESULT CODES

noErr	0	No error
nsvErr	-35	No such volume
ioErr	-36	I/O error
bdNamErr	-37	Bad filename
fnfErr	-43	File not found
paramErr	-50	No default volume
dirNFErr	-120	Directory not found or incomplete pathname
afpAccessDenied	-5000	User does not have the correct access
afpObjectTypeErr	-5025	Directory not found or incomplete pathname