os::Volumes Class Reference
[The Syllable high level filesystem API]

Information about the mounted volumes. More...

List of all members.

Public Member Functions
	Volumes ()
	~Volumes ()
uint	GetMountPointCount ()
	Return the number of mount points.
status_t	GetMountPoint (uint nIndex, String *cMountPoint)
	Return a mountpoint.
status_t	GetFSInfo (uint nIndex, fs_info *psInfo)
	Return information about a mounted filesystem.
Window *	MountDialog (const Messenger &cMsgTarget, Message *pcMountMsg)
	Create a mount dialog.
void	Unmount (String cMountPoint, const Messenger &cMsgTarget, Message *pcFinishMsg)
	Unmounts a volume.

---

Detailed Description

Description:

This class makes it possible to get a list of the mounted volumes and also offers a way to mount and unmount volumes.

Author:

Henrik Isaksson ([email protected])

---

Constructor & Destructor Documentation

Volumes::Volumes

(

)

Volumes::~Volumes

(

)

---

Member Function Documentation

uint Volumes::GetMountPointCount

(

)

Description:

Returns the number of mount points.

Returns:

The number of mount points.

Author:

Arno Klenke ([email protected])

status_t Volumes::GetMountPoint	(	uint	nIndex,
		String *	cMountPoint
	)

Description:

After a successful call of this method, cMountPoint will contain the path of the mountpoint specified by nIndex.

Parameters:

	nIndex	- Index of the mountpoint.
	cMountPoint	- Will contain the path of the mountpoint after the call.

Returns:

0 if successful.

Author:

Arno Klenke ([email protected])

status_t Volumes::GetFSInfo	(	uint	nIndex,
		fs_info *	psInfo
	)

Description:

After a successful call of this method, psInfo will contain filesystem related information about the mountpoint specified by nIndex.

Parameters:

	nIndex	- Index of the mountpoint.
	psInfo	- Pointer to a fs_info structure.

Returns:

0 if successful.

Author:

Arno Klenke ([email protected])

Window * Volumes::MountDialog	(	const Messenger &	cMsgTarget,
		Message *	pcMountMsg
	)

Description:

Creates a dialog which lists all volumes that can be mounted and lets the user select one. When a volume is mounted, pcMountMsg will be sent to the supplied message target.

Note:

Don’t forget to place the window at the right position and show it.

Parameters:

	cMsgTarget	- The target that will receive the message.
	cMountMsg	- The message that will be sent.

Returns:

Pointer to the created window.

Author:

Arno Klenke ([email protected])

void Volumes::Unmount	(	String	cMountPoint,
		const Messenger &	cMsgTarget,
		Message *	pcFinishMsg
	)

Description:

Unmounts the volume specified by cMountPoint. After the volume has been unmounted, pcFinish will be sent to the supplied message target.

Parameters:

	cMountPoint	- The mountpoint.
	cMsgTarget	- The target that will receive the message.
	cMountMsg	- The message that will be sent.

Author:

Arno Klenke ([email protected])

---