IBackgroundCopyJob::SetDisplayName 方法 (bits.h)

指定作业的显示名称。 通常,使用显示名称在用户界面中标识作业。

语法

HRESULT SetDisplayName(
  [in] LPCWSTR Val
);

参数

[in] Val

标识作业的以 Null 结尾的字符串。 不得为 NULL。 字符串的长度限制为 256 个字符,不包括 null 终止符。

返回值

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

返回代码 说明
S_OK
已成功设置显示名称。
E_INVALIDARG
pDisplayName 参数不能为 NULL 或名称超过 256 个字符。
BG_E_STRING_TOO_LONG
显示名称超过 256 个字符。
BG_E_INVALID_STATE
作业的状态不能BG_JOB_STATE_CANCELLED或BG_JOB_STATE_ACKNOWLEDGED。

注解

最初在创建作业时设置显示名称。 有关在创建作业时指定显示名称的详细信息,请参阅 IBackgroundCopyManager::CreateJob 方法。

要求

要求
最低受支持的客户端 Windows XP
最低受支持的服务器 Windows Server 2003
目标平台 Windows
标头 bits.h
Library Bits.lib
DLL QmgrPrxy.dll

另请参阅

IBackgroundCopyJob::GetDisplayName

IBackgroundCopyManager::CreateJob