File Manager Reference
PDF
Overview
Functions by Task
Accessing Information About Files and Directories
Accessing the Desktop Database
Allocating Storage for Files
Closing Files
Comparing File System References
Controlling Directory Access
Controlling Login Access
Converting Between Paths and FSRef Structures
Copying and Moving Files
Copying and Moving Objects Using Asynchronous High-Level File Operations
Copying and Moving Objects Using Synchronous High-Level File Operations
Creating a File System Reference (FSRef)
Creating and Deleting File ID References
Creating and Deleting Named Forks
Creating Directories
Creating File System Specifications
Creating Files
Creating, Calling, and Deleting Universal Procedure Pointers
Deleting Files and Directories
Determining the Unicode Names of the Data and Resource Forks
Exchanging the Contents of Two Files
Getting and Setting Volume Information
Getting Volume Attributes
Iterating Over Named Forks
Locking and Unlocking File Ranges
Locking and Unlocking Files and Directories
Manipulating File and Fork Size
Manipulating File Position
Manipulating the Default Volume
Mounting and Unmounting Volumes
Mounting Remote Volumes
Moving and Renaming Files or Directories
Obtaining File and Directory Information Using a Catalog Iterator on HFS Plus Volumes
Obtaining File Control Block Information
Obtaining Fork Control Block Information
Opening Files
Opening Files While Denying Access
Reading and Writing Files
Resolving File ID References
Searching a Volume
Searching a Volume Using a Catalog Iterator
Updating Files
Updating Volumes
Using Change Notifications
Not Recommended
Functions
DisposeFNSubscriptionUPP
DisposeFSVolumeEjectUPP
DisposeFSVolumeMountUPP
DisposeFSVolumeUnmountUPP
DisposeIOCompletionUPP
FNGetDirectoryForSubscription
FNNotify
FNNotifyAll
FNNotifyByPath
FNSubscribe
FNSubscribeByPath
FNUnsubscribe
FSAllocateFork
FSCancelVolumeOperation
FSCatalogSearch
FSCloseFork
FSCloseIterator
FSCompareFSRefs
FSCopyDiskIDForVolume
FSCopyObjectAsync
FSCopyObjectSync
FSCopyURLForVolume
FSCreateDirectoryUnicode
FSCreateFileUnicode
FSCreateFork
FSCreateVolumeOperation
FSDeleteFork
FSDeleteObject
FSDisposeVolumeOperation
FSEjectVolumeAsync
FSEjectVolumeSync
FSExchangeObjects
FSFileOperationCancel
FSFileOperationCopyStatus
FSFileOperationCreate
FSFileOperationGetTypeID
FSFileOperationScheduleWithRunLoop
FSFileOperationUnscheduleFromRunLoop
FSFlushFork
FSFlushVolume
FSGetAsyncEjectStatus
FSGetAsyncMountStatus
FSGetAsyncUnmountStatus
FSGetCatalogInfo
FSGetCatalogInfoBulk
FSGetDataForkName
FSGetForkCBInfo
FSGetForkPosition
FSGetForkSize
FSGetResourceForkName
FSGetVolumeInfo
FSGetVolumeMountInfo
FSGetVolumeMountInfoSize
FSGetVolumeParms
FSIterateForks
FSLockRange
FSMakeFSRefUnicode
FSMountLocalVolumeAsync
FSMountLocalVolumeSync
FSMountServerVolumeAsync
FSMountServerVolumeSync
FSMoveObject
FSMoveObjectAsync
FSMoveObjectSync
FSMoveObjectToTrashAsync
FSMoveObjectToTrashSync
FSOpenFork
FSOpenIterator
FSPathCopyObjectAsync
FSPathCopyObjectSync
FSPathFileOperationCopyStatus
FSPathMakeRef
FSPathMakeRefWithOptions
FSPathMoveObjectAsync
FSPathMoveObjectSync
FSPathMoveObjectToTrashAsync
FSPathMoveObjectToTrashSync
FSReadFork
FSRefMakePath
FSRenameUnicode
FSSetCatalogInfo
FSSetForkPosition
FSSetForkSize
FSSetVolumeInfo
FSUnlockRange
FSUnmountVolumeAsync
FSUnmountVolumeSync
FSVolumeMount
FSWriteFork
InvokeFNSubscriptionUPP
InvokeFSVolumeEjectUPP
InvokeFSVolumeMountUPP
InvokeFSVolumeUnmountUPP
InvokeIOCompletionUPP
NewFNSubscriptionUPP
NewFSVolumeEjectUPP
NewFSVolumeMountUPP
NewFSVolumeUnmountUPP
NewIOCompletionUPP
PBAllocateForkAsync
PBAllocateForkSync
PBCatalogSearchAsync
PBCatalogSearchSync
PBCloseForkAsync
PBCloseForkSync
PBCloseIteratorAsync
PBCloseIteratorSync
PBCompareFSRefsAsync
PBCompareFSRefsSync
PBCreateDirectoryUnicodeAsync
PBCreateDirectoryUnicodeSync
PBCreateFileUnicodeAsync
PBCreateFileUnicodeSync
PBCreateForkAsync
PBCreateForkSync
PBDeleteForkAsync
PBDeleteForkSync
PBDeleteObjectAsync
PBDeleteObjectSync
PBExchangeObjectsAsync
PBExchangeObjectsSync
PBFlushForkAsync
PBFlushForkSync
PBFlushVolumeAsync
PBFlushVolumeSync
PBFSCopyFileAsync
PBFSCopyFileSync
PBGetCatalogInfoAsync
PBGetCatalogInfoBulkAsync
PBGetCatalogInfoBulkSync
PBGetCatalogInfoSync
PBGetForkCBInfoAsync
PBGetForkCBInfoSync
PBGetForkPositionAsync
PBGetForkPositionSync
PBGetForkSizeAsync
PBGetForkSizeSync
PBGetVolumeInfoAsync
PBGetVolumeInfoSync
PBIterateForksAsync
PBIterateForksSync
PBMakeFSRefUnicodeAsync
PBMakeFSRefUnicodeSync
PBMoveObjectAsync
PBMoveObjectSync
PBOpenForkAsync
PBOpenForkSync
PBOpenIteratorAsync
PBOpenIteratorSync
PBReadForkAsync
PBReadForkSync
PBRenameUnicodeAsync
PBRenameUnicodeSync
PBSetCatalogInfoAsync
PBSetCatalogInfoSync
PBSetForkPositionAsync
PBSetForkPositionSync
PBSetForkSizeAsync
PBSetForkSizeSync
PBSetVolumeInfoAsync
PBSetVolumeInfoSync
PBWriteForkAsync
PBWriteForkSync
PBXLockRangeAsync
PBXLockRangeSync
PBXUnlockRangeAsync
PBXUnlockRangeSync
Callbacks by Task
File Operation Callbacks
Miscellaneous Callbacks
Callbacks
FNSubscriptionProcPtr
FSFileOperationStatusProcPtr
FSPathFileOperationStatusProcPtr
FSVolumeEjectProcPtr
FSVolumeMountProcPtr
FSVolumeUnmountProcPtr
IOCompletionProcPtr
Data Types
AccessParam
AFPAlternateAddress
AFPTagData
AFPVolMountInfo
AFPXVolMountInfo
CatPositionRec
CInfoPBRec
CMovePBRec
CntrlParam
ConstFSSpecPtr
ConstHFSUniStr255Param
CopyParam
CSParam
DirInfo
DrvQEl
DTPBRec
FCBPBRec
FIDParam
FileParam
FNSubscriptionRef
FNSubscriptionUPP
ForeignPrivParam
FSCatalogBulkParam
FSCatalogInfo
FSCatalogInfoBitmap
FSEjectStatus
FSFileOperationClientContext
FSFileOperationRef
FSForkCBInfoParam
FSForkInfo
FSForkIOParam
FSIterator
FSMountStatus
FSPermissionInfo
FSRangeLockParam
FSRangeLockParamPtr
FSRef
FSRefParam
FSSearchParams
FSSpec
FSSpecArrayPtr
FSUnmountStatus
FSVolumeEjectUPP
FSVolumeInfo
FSVolumeInfoBitmap
FSVolumeInfoParam
FSVolumeMountUPP
FSVolumeOperation
FSVolumeRefNum
FSVolumeUnmountUPP
GetVolParmsInfoBuffer
HFileInfo
HFileParam
HFSUniStr255
HIOParam
HParamBlockRec
HVolumeParam
IOCompletionUPP
IOParam
MultiDevParam
ObjParam
ParamBlockRec
SlotDevParam
VCB
VolMountInfoHeader
VolumeMountInfoHeader
VolumeParam
VolumeType
WDParam
WDPBRec
XCInfoPBRec
XIOParam
XVolumeParam
Constants
AFP Tag Length Constants
AFP Tag Type Constants
Allocation Flags
AppleShare Volume Signature
Authentication Method Constants
Cache Constants
Catalog Information Bitmap Constants
Catalog Information Node Flags
Catalog Information Sharing Flags
Catalog Search Bits
Catalog Search Constants
Catalog Search Masks
Extended AFP Volume Mounting Information Flag
Extended Volume Attributes
FCB Flags
File Access Permission Constants
File and Folder Access Privilege Constants
File Attribute Constants
File Operation Options
File Operation Stages
File Operation Status Dictionary Keys
FNMessage
Foreign Privilege Model Constant
Group ID Constant
Icon Size Constants
Icon Type Constants
Invalid Volume Reference Constant
Iterator Flags
kAsyncMountInProgress
Notification Subscription Options
kHFSCatalogNodeIDsReusedBit
Large Volume Constants
Mapping Code Constants
Path Conversion Options
Position Mode Constants
Root Directory Constants
User ID Constants
User Privileges Constants
Volume Attribute Constants
Volume Control Block Flags
Volume Information Attribute Constants
Volume Information Bitmap Constants
Volume Information Flags
Volume Mount Flags
Result Codes
Appendix A: Deprecated File Manager Functions
Deprecated in Mac OS X v10.4
Allocate
AllocContig
CatMove
DirCreate
FSClose
FSMakeFSSpec
FSpCatMove
FSpCreate
FSpDelete
FSpDirCreate
FSpExchangeFiles
FSpGetFInfo
FSpOpenDF
FSpOpenRF
FSpRename
FSpRstFLock
FSpSetFInfo
FSpSetFLock
FSRead
FSWrite
GetEOF
GetFPos
GetVRefNum
HCreate
HDelete
HGetFInfo
HGetVol
HOpen
HOpenDF
HOpenRF
HRename
HRstFLock
HSetFInfo
HSetFLock
HSetVol
PBAllocateAsync
PBAllocateSync
PBAllocContigAsync
PBAllocContigSync
PBCatMoveAsync
PBCatMoveSync
PBCatSearchAsync
PBCatSearchSync
PBDirCreateAsync
PBDirCreateSync
PBDTAddAPPLAsync
PBDTAddAPPLSync
PBDTAddIconAsync
PBDTAddIconSync
PBDTCloseDown
PBDTDeleteAsync
PBDTDeleteSync
PBDTFlushAsync
PBDTFlushSync
PBDTGetAPPLAsync
PBDTGetAPPLSync
PBDTGetCommentAsync
PBDTGetCommentSync
PBDTGetIconAsync
PBDTGetIconInfoAsync
PBDTGetIconInfoSync
PBDTGetIconSync
PBDTGetInfoAsync
PBDTGetInfoSync
PBDTGetPath
PBDTOpenInform
PBDTRemoveAPPLAsync
PBDTRemoveAPPLSync
PBDTRemoveCommentAsync
PBDTRemoveCommentSync
PBDTResetAsync
PBDTResetSync
PBDTSetCommentAsync
PBDTSetCommentSync
PBExchangeFilesAsync
PBExchangeFilesSync
PBFlushFileAsync
PBFlushFileSync
PBGetCatInfoAsync
PBGetCatInfoSync
PBGetEOFAsync
PBGetEOFSync
PBGetFCBInfoAsync
PBGetFCBInfoSync
PBGetForeignPrivsAsync
PBGetForeignPrivsSync
PBGetFPosAsync
PBGetFPosSync
PBGetUGEntryAsync
PBGetUGEntrySync
PBGetXCatInfoAsync
PBGetXCatInfoSync
PBHCreateAsync
PBHCreateSync
PBHDeleteAsync
PBHDeleteSync
PBHGetFInfoAsync
PBHGetFInfoSync
PBHGetLogInInfoAsync
PBHGetLogInInfoSync
PBHGetVInfoAsync
PBHGetVInfoSync
PBHGetVolAsync
PBHGetVolSync
PBHMoveRenameAsync
PBHMoveRenameSync
PBHOpenAsync
PBHOpenDFAsync
PBHOpenDFSync
PBHOpenRFAsync
PBHOpenRFSync
PBHOpenSync
PBHRenameAsync
PBHRenameSync
PBHRstFLockAsync
PBHRstFLockSync
PBHSetFInfoAsync
PBHSetFInfoSync
PBHSetFLockAsync
PBHSetFLockSync
PBHSetVolAsync
PBHSetVolSync
PBLockRangeAsync
PBLockRangeSync
PBMakeFSSpecAsync
PBMakeFSSpecSync
PBSetCatInfoAsync
PBSetCatInfoSync
PBSetEOFAsync
PBSetEOFSync
PBSetForeignPrivsAsync
PBSetForeignPrivsSync
PBSetFPosAsync
PBSetFPosSync
PBSetVInfoAsync
PBSetVInfoSync
PBShareAsync
PBShareSync
PBUnlockRangeAsync
PBUnlockRangeSync
PBUnmountVol
PBUnshareAsync
PBUnshareSync
PBXGetVolInfoAsync
PBXGetVolInfoSync
SetEOF
SetFPos
UnmountVol
Deprecated in Mac OS X v10.5
FlushVol
FSpMakeFSRef
PBCloseAsync
PBCloseSync
PBCreateFileIDRefAsync
PBCreateFileIDRefSync
PBDeleteFileIDRefAsync
PBDeleteFileIDRefSync
PBFlushVolAsync
PBFlushVolSync
PBGetVolMountInfo
PBGetVolMountInfoSize
PBHCopyFileAsync
PBHCopyFileSync
PBHGetDirAccessAsync
PBHGetDirAccessSync
PBHGetVolParmsAsync
PBHGetVolParmsSync
PBHMapIDAsync
PBHMapIDSync
PBHMapNameAsync
PBHMapNameSync
PBHOpenDenyAsync
PBHOpenDenySync
PBHOpenRFDenyAsync
PBHOpenRFDenySync
PBHSetDirAccessAsync
PBHSetDirAccessSync
PBMakeFSRefAsync
PBMakeFSRefSync
PBReadAsync
PBReadSync
PBResolveFileIDRefAsync
PBResolveFileIDRefSync
PBVolumeMount
PBWaitIOComplete
PBWriteAsync
PBWriteSync
Revision History
Index