IProgressItem::get_Description method (imapi2fs.h)

Retrieves the description in the progress item.

Syntax

HRESULT get_Description(
  [out] BSTR *desc
);

Parameters

[out] desc

String containing the description. The description contains the name of the file in the file system image.

Return value

S_OK is returned on success, but other success codes may be returned as a result of implementation. The following error codes are commonly returned on operation failure, but do not represent the only possible error values:

Return code Description
E_POINTER
Pointer is not valid.

Value: 0x80004003

Requirements

Requirement Value
Minimum supported client Windows Vista, Windows XP with SP2 [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header imapi2fs.h

See also

IProgressItem