IBackgroundCopyJob::SetDescription 方法 (bits.h)

提供作業的描述。

語法

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作業的狀態。

規格需求

需求
最低支援的用戶端 Windows XP
最低支援的伺服器 Windows Server 2003
目標平台 Windows
標頭 bits.h
程式庫 Bits.lib
Dll QmgrPrxy.dll

另請參閱

IBackgroundCopyJob::GetDescription