指定工作名稱。 通常,使用者介面中會使用顯示名稱來識別工作。
語法
HRESULT SetDisplayName(
[in] LPCWSTR Val
);
參數
[in] Val
用空終端字串識別作業。 不能是 NULL。 字串長度限制為 256 個字元,不包含空終端碼。
返回值
此方法回傳以下 HRESULT 值及其他值。
| 回傳碼 | Description |
|---|---|
|
顯示名稱已成功設定。 |
|
pDisplayName 參數不能為 NULL,且名稱不能超過 256 個字元。 |
|
顯示名稱超過 256 個字元。 |
|
工作狀態無法BG_JOB_STATE_CANCELLED或BG_JOB_STATE_ACKNOWLEDGED。 |
備註
顯示名稱是在你建立工作時設定的。 關於建立工作時指定顯示名稱的細節,請參見 IBackgroundCopyManager::CreateJob 方法。
需求
| Requirement | 價值觀 |
|---|---|
| 最低支援的用戶端 | 視窗XP |
| 支援的最低伺服器 | Windows Server 2003 |
| 目標平臺 | 窗戶 |
| Header | Bits.h |
| Library | Bits.lib |
| DLL | QmgrPrxy.dll |