Do not derive your own classes from this class.
Constructors & DestructorUse the functions in this group to construct and destroy IVolume objects.
![]() |
public:
virtual ~IVolume()
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
![]() |
public:
IVolume()
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
public:
IVolume(const IVolume& copy)
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
Class constants
Obtaining Volume Property InformationUse the functions in this group to obtain property information about a volume, such as the total amount of space, the amount of available space, whether it is local or remote, and whether it is removable.
![]() |
public:
IFileSize freeSpace() const
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
![]() |
public:
IFSVolumeRecord* getRecord() const
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
![]() |
public:
EState online() const
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
![]() |
public:
EState remote() const
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
![]() |
public:
EState removable() const
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
![]() |
public:
IFileSize totalSpace() const
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
Special "Downcast" ConstructorsUse the constructors in this group to create IVolume objects based on the given information, such as a host path name, a partial path name, a file system entity, or a file system volume record.
![]() |
public:
IVolume(const IFileSystemEntity& copy)
| IEntityTypeMismatch | thrown if the specified entity is not a volume |
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
public:
IVolume(IFSVolumeRecord* Record)
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
public:
IVolume( const IHostPathName& path, const ICompoundNameParser& = defaultParser ( ) )
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
![]() |
public:
IVolume& operator =(const IFileSystemEntity& right)
| IEntityTypeMismatch | thrown if the specified entity is not a volume |
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
![]() |
enum EState { kFalse=0,
kUnknown,
kTrue }kUnknown means that the state could not be determined, either because the host operating system does not support that type of state or because determining the state would be an unreasonably expensive operation.
| Windows | OS/2 | AIX |
| Yes | Yes | Yes |
virtual ~IDirectory()
IDirectory createDirectory( const IFileName& pathOrName, const ICompoundNameParser& = defaultParser ( ) )
IFile createFile( const IFileName& name, IFileSize initialSize = 0, const ICompoundNameParser& = defaultParser ( ) )
static IDirectory createTemporary( const IFileName& dirName = uniqueName ( ) )
static IDirectory current()
void deleteAllContents()
IFSDirectoryRecord* getRecord() const
IDirectory( const IPathName& path, ECreateFlags flags = kMustExist )
IDirectory(IFSDirectoryRecord* Record)
IDirectory(const IDirectory& copy)
IDirectory( const IHostPathName& path, ECreateFlags flags = kMustExist, const ICompoundNameParser& = defaultParser ( ) )
IDirectory(const IFileSystemEntity& copy)
IDirectory()
IFileSystemEntity lookUp( const IHostPathName& pathOrName, const ICompoundNameParser& = defaultParser ( ) ) const
IFileSystemEntity lookUp( const IPathName& partialPath ) const
IDirectory& operator =(const IFileSystemEntity& right)
static void setCurrent(const IDirectory&)
virtual ~IFileSystemEntity()
bool connected() const
IFileSystemEntity copyTo( IDirectory& destination, const IFileName& newName = "", EFailureAction action = kStop ) const
static const ICompoundNameParser& defaultParser()
void deleteSelf(bool deleteChildren = false)
IFSRecord* getRecord() const
IHostPathName hostPath( const ICompoundNameParser& parser = defaultParser ( ) ) const
IFileSystemEntity(const IFileSystemEntity& copy)
IFileSystemEntity(const IPathName& path)
IFileSystemEntity( const IHostPathName& hostPath, const ICompoundNameParser& = defaultParser ( ) )
IFileSystemEntity()
IFileSystemEntity(IFSRecord* Record)
bool isA(const IFileKind& kind) const
ITimeStamp modificationTime() const
void moveTo( IDirectory& destination, const IFileName& newName = "", EFailureAction action = kStop )
IFileName name() const
bool operator !=(const IFileSystemEntity& object) const
virtual IFileSystemEntity& operator =( const IFileSystemEntity& right )
bool operator ==(const IFileSystemEntity& object) const
IDirectory parent() const
IPathName path() const
virtual void readFromStream(IDataStream& fromwhere)
void setName(const IFileName& newName) const
bool temporary() const
IDirectory topmostParent() const
static const IFileName& uniqueName()
bool valid() const
IVolume volume() const
virtual void writeToStream(IDataStream& towhere) const
virtual ~IMStreamable()
void externalizeToStream(IDataStream& towhere) const
void internalizeFromStream(IDataStream& fromwhere)
virtual const ITypeRepresentation& typeRepresentation() const = 0
IMStreamable()
IMStreamable(const IMStreamable& other)
virtual void readFromStream(IDataStream& fromwhere) = 0
virtual void writeToStream(IDataStream& towhere) const = 0
void setInvalid()
void
typeSafeAssign( const IFileSystemEntity& right,
const IFileKind& kind )