IBackgroundCopyJob：：SetDisplayName 方法 (bits.h)

指定作業的顯示名稱。一般而言，您會使用顯示名稱來識別使用者介面中的作業。

語法

HRESULT SetDisplayName(
  [in] LPCWSTR Val
);

[in] Val

識別作業的 Null 終止字串。不得為 NULL。字串的長度限制為 256 個字元，不包括 Null 終止符。

這個方法會傳回下列 HRESULT 值，以及其他值。

傳回碼	Description
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 方法。