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:

## Public Member Functions
void | close ()
| Closes this directory.
void | read ([retval] out IFsObjInfo objInfo)
| Reads the next directory entry of this directory.

## Public Attributes
readonly attribute wstring | directoryName
| The path specified when opening the directory.
readonly attribute wstring | filter
| Directory listing filter to (specified when opening the directory).

## Detailed Description

Abstract parent interface for directories handled by VirtualBox.

Interface ID:
  `{758D7EAC-E4B1-486A-8F2E-747AE346C3E9}`

## Member Function Documentation

## ◆ close()

void IDirectory::close | ( |  | ) |

Closes this directory.

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

## ◆ read()

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

Reads the next directory entry of this directory.

Parameters

  objInfo | Object 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

## ◆ directoryName

readonly attribute wstring IDirectory::directoryName

The path specified when opening the directory.

## ◆ filter

readonly attribute wstring IDirectory::filter

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