Legacy Document

Inside Macintosh: Files /

Chapter 2 - File Manager / File Manager Reference

Low-Level Volume Access Routines / Mounting and Unmounting Volumes

PBOffLine

You can use the PBOffLine function to place a volume offline. Most applications don't need to do this.

FUNCTION PBOffLine (paramBlock: ParmBlkPtr): OSErr;

paramBlock

A pointer to a basic File Manager parameter block.

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

DESCRIPTION

The PBOffLine function places the specified volume offline by calling PBFlushVol to flush the volume and releasing all the memory used for the volume except for the volume control block.

The PBOffLine function always executes synchronously.

ASSEMBLY-LANGUAGE INFORMATION

The trap macro for PBOffLine is _OffLine.

RESULT CODES

noErr	0	No error
nsvErr	-35	No such volume
ioErr	-36	I/O error
bdNamErr	-37	Bad volume name
paramErr	-50	No default volume
nsDrvErr	-56	No such drive
extFSErr	-58	External file system