class PlpDrive

 A class representing information about a Disk drive on the psion. More...
Definition#include <lib/plpdirent.h>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Detailed Description

A class representing information about a Disk drive on the psion. An Object of this type is used by rfsv::devinfo for returning the information of the probed drive.

 PlpDrive ()

Default constructor.

 PlpDrive (const PlpDrive &other)

Copy constructor

u_int32_t  getMediaType ()

Retrieve the media type of the drive. 


 Media types are encoded by a number
 in the range 0 .. 8 with the following
 meaning:

   0 = Not present
   1 = Unknown
   2 = Floppy
   3 = Disk
   4 = CD-ROM
   5 = RAM
   6 = Flash Disk
   7 = ROM
   8 = Remote

Returns: The media type of the probed drive.

void  getMediaType (std::string &ret)

Retrieve the media type of the drive. Just like the above function, but returns the media type as human readable string.

Parameters:
retThe string is returned here.

u_int32_t  getDriveAttribute ()

Retrieve the attributes of the drive. 


 Drive attributes are encoded by a number
 in the range 0 .. 63. The bits have the
 the following meaning:

   bit 0 = local
   bit 1 = ROM
   bit 2 = redirected
   bit 3 = substituted
   bit 4 = internal
   bit 5 = removable

Returns: The attributes of the probed drive.

void  getDriveAttribute (std::string &ret)

Retrieve the attributes of the drive. Just like the above function, but returns the attributes as human readable string.

Parameters:
retThe string is returned here.

u_int32_t  getMediaAttribute ()

Retrieve the attributes of the media. 


 Media attributes are encoded by a number
 in the range 0 .. 15. The bits have the
 following meaning:

   bit 0 = variable size
   bit 1 = dual density
   bit 2 = formattable
   bit 3 = write protected

Returns: The attributes of the probed media.

void  getMediaAttribute (std::string &ret)

Retrieve the attributes of the media. Just like the above function, but returns the attributes as human readable string.

Parameters:
retThe string is returned here.

u_int32_t  getUID ()

Retrieve the UID of the drive. Each drive, except the ROM drive on a Psion has a unique ID which can be retrieved here.

Returns: The UID of the probed drive.

u_int64_t  getSize ()

Retrieve the total capacity of the drive.

Returns: The capacity of the probed drive in bytes.

u_int64_t  getSpace ()

Retrieve the free capacity on the drive.

Returns: The free space on the probed drive in bytes.

std::string  getName ()

Retrieve the volume name of the drive.

returns The volume name of the drive.

char  getDrivechar ()

Retrieve the drive letter of the drive.

returns The letter of the probed drive.