Open CASCADE Technology 6.6.0
Public Member Functions
OSD_Disk Class Reference

Disk management

#include <OSD_Disk.hxx>

Public Member Functions

 OSD_Disk ()
 Creates a disk object.
This is used only when a class contains a Disk field.
By default, its name is initialized to current working disk.

 OSD_Disk (const OSD_Path &Name)
 Initializes the object Disk with the disk name
associated to the OSD_Path.

 OSD_Disk (const Standard_CString PathName)
 Initializes the object Disk with <PathName>.
<PathName> specifies any file within the mounted
file system.
Example : OSD_Disk myDisk ("/tmp")
Initializes a disk object with the mounted
file associated to /tmp.

OSD_Path Name () const
 Returns disk name of <me>.

void SetName (const OSD_Path &Name)
 Instantiates <me> with <Name>.

Standard_Integer DiskSize ()
 Returns total disk capacity in 512 bytes blocks.

Standard_Integer DiskFree ()
 Returns free available 512 bytes blocks on disk.

Standard_Integer DiskQuota ()
 Returns user's disk quota (in Bytes).

void SetDiskQuota (const Standard_Integer QuotaSize)
 Sets user's disk quota (in Bytes).
Warning: Needs system administrator privilege.

void SetQuotaOn ()
 Activates user's disk quota
Warning: Needs system administrator privilege.

void SetQuotaOff ()
 Deactivates user's disk quota
Warning: Needs system administrator privilege.

Standard_Boolean Failed () const
 Returns TRUE if an error occurs

void Reset ()
 Resets error counter to zero

void Perror ()
 Raises OSD_Error

Standard_Integer Error () const
 Returns error number if 'Failed' is TRUE.


Constructor & Destructor Documentation

OSD_Disk::OSD_Disk ( )
OSD_Disk::OSD_Disk ( const OSD_Path Name)
OSD_Disk::OSD_Disk ( const Standard_CString  PathName)

Member Function Documentation

Standard_Integer OSD_Disk::DiskFree ( )
Standard_Integer OSD_Disk::DiskQuota ( )
Standard_Integer OSD_Disk::DiskSize ( )
Standard_Integer OSD_Disk::Error ( ) const
Standard_Boolean OSD_Disk::Failed ( ) const
OSD_Path OSD_Disk::Name ( ) const
void OSD_Disk::Perror ( )
void OSD_Disk::Reset ( )
void OSD_Disk::SetDiskQuota ( const Standard_Integer  QuotaSize)
void OSD_Disk::SetName ( const OSD_Path Name)
void OSD_Disk::SetQuotaOff ( )
void OSD_Disk::SetQuotaOn ( )

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines