IBackgroundCopyJob::SetDescription method (bits.h)

Provides a description of the job.

Syntax

HRESULT SetDescription(
  [in] LPCWSTR Val
);

Parameters

[in] Val

Null-terminated string that provides additional information about the job. The length of the string is limited to 1,024 characters, not including the null terminator.

Return value

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

Return code	Description
S_OK	Description of the job was successfully set.
E_INVALIDARG	The pDescription parameter cannot be NULL.
BG_E_STRING_TOO_LONG	The description exceeds 1,024 characters.
BG_E_INVALID_STATE	The state of the job cannot be BG_JOB_STATE_CANCELLED or BG_JOB_STATE_ACKNOWLEDGED.

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::GetDescription