Legacy Document

Inside Macintosh: Files /

Chapter 2 - File Manager / File Manager Reference

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

PBHRstFLock

You can use the PBHRstFLock function to unlock a file.

FUNCTION PBHRstFLock (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.
-->	ioDirID	LongInt	A directory ID.

DESCRIPTION

The PBHRstFLock function unlocks the file with the name pointed to by ioNamePtr on the volume specified by ioVRefNum. Access paths currently in use aren't affected.

If the PBHGetVolParms function indicates that the volume supports folder locking (that is, the bHasFolderLock bit of the vMAttrib field is set), you can use PBHRstFLock to unlock a directory.

ASSEMBLY-LANGUAGE INFORMATION

The trap macro for PBHRstFLock is _HRstFLock.

RESULT CODES

noErr	0	No error
nsvErr	-35	No such volume
ioErr	-36	I/O error
fnfErr	-43	File not found
wPrErr	-44	Hardware volume lock
vLckdErr	-46	Software volume lock
dirNFErr	-120	Directory not found or incomplete pathname
afpAccessDenied	-5000	User does not have the correct access to the file
afpObjectTypeErr	-5025	Folder locking not supported by volume