Legacy Document

Inside Macintosh: Files /

Chapter 2 - File Manager / File Manager Reference

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

HSetFLock

You can use the HSetFLock function to lock a file.

FUNCTION HSetFLock (vRefNum: Integer; dirID: LongInt; 
                     fileName: Str255): OSErr;

vRefNum

A volume reference number, a working directory reference number, or 0 for the default volume.

dirID

A directory ID.

fileName

The name of the file.

DESCRIPTION

The HSetFLock function locks a file. After you lock a file, all new access paths to that file are read-only. This function has no effect on existing access paths.

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 HSetFLock to lock a directory.

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