VirtualBox Main API
Public Member Functions | Public Attributes | List of all members
IDirectory Interface Reference

Abstract parent interface for directories handled by VirtualBox. More...

Inheritance diagram for IDirectory:
IGuestDirectory

Public Member Functions

void close ()
 Closes this directory. More...
 
void read ([retval] out IFsObjInfo objInfo)
 Reads the next directory entry of this directory. More...
 

Public Attributes

readonly attribute wstring directoryName
 The path specified when opening the directory. More...
 
readonly attribute wstring filter
 Directory listing filter to (specified when opening the directory). More...
 

Detailed Description

Abstract parent interface for directories handled by VirtualBox.

Interface ID:
{F73650F4-4506-50CA-045A-23A0E32EA508}

Member Function Documentation

void IDirectory::close ( )

Closes this directory.

After closing operations like reading the next directory entry will not be possible anymore.

void IDirectory::read ( [retval] out IFsObjInfo  objInfo)

Reads the next directory entry of this directory.

Parameters
objInfoObject information of the current directory entry read. Also see IFsObjInfo.
Expected result codes:
VBOX_E_OBJECT_NOT_FOUND No more directory entries to read.

Member Data Documentation

readonly attribute wstring IDirectory::directoryName

The path specified when opening the directory.

readonly attribute wstring IDirectory::filter

Directory listing filter to (specified when opening the directory).