IProgressItems::ProgressItemFromDescription method (imapi2fs.h)

2024-02-22

Retrieves a progress item based on the specified file name.

Syntax

HRESULT ProgressItemFromDescription(
  [in]  BSTR          description,
  [out] IProgressItem **item
);

Parameters

[in] description

String that contains the file name of the progress item to retrieve. The method returns the progress item if this string matches the value for item's description property.

[out] item

An IProgressItem interface of the progress item associated with the specified file name.

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_FAIL	description is NULL. Value:0x80004005
E_POINTER	Pointer is not valid. Value: 0x80004003
E_OUTOFMEMORY	Failed to allocate the required memory. Value: 0x8007000E
E_INVALIDARG	One or more arguments are not valid. Value: 0x80070057

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

Feedback

Var den här sidan till hjälp?