IBackgroundCopyJob::GetDescription method (bits.h)

Retrieves the description of the job.

Syntax

HRESULT GetDescription(
  [out] LPWSTR *pVal
);

Parameters

[out] pVal

Null-terminated string that contains a short description of the job. Call the CoTaskMemFree function to free ppDescription when done.

Return value

This method returns the following HRESULT values, as well as others.

Return code	Description
S_OK	Description of the job was successfully retrieved.
E_INVALIDARG	The parameter, ppDescription, cannot be NULL.

Requirements

Requirement	Value
Minimum supported client	Windows XP
Minimum supported server	Windows Server 2003
Target Platform	Windows
Header	bits.h
Library	Bits.lib
DLL	QmgrPrxy.dll

See also

IBackgroundCopyJob::SetDescription