IBackgroundCopyJob::SetDescription 方法 (bits.h)

提供作业的说明。

Syntax

HRESULT SetDescription(
  [in] LPCWSTR Val
);

参数

[in] Val

以 Null 结尾的字符串,提供有关作业的其他信息。 字符串的长度限制为 1,024 个字符,不包括 null 终止符。

返回值

此方法返回以下 HRESULT 值以及其他值。

返回代码 Description
S_OK
已成功设置作业的说明。
E_INVALIDARG
pDescription 参数不能为 NULL
BG_E_STRING_TOO_LONG
说明超过 1,024 个字符。
BG_E_INVALID_STATE
作业的状态不能BG_JOB_STATE_CANCELLED或BG_JOB_STATE_ACKNOWLEDGED。

要求

Requirement 价值
最低支持的客户端 Windows XP
支持的最低服务器 Windows Server 2003
目标平台 Windows操作系统
Header bits.h
Library Bits.lib
DLL QmgrPrxy.dll

另请参阅

IBackgroundCopyJob::GetDescription