IBackgroundCopyJob::SetDescription メソッド (bits.h)

ジョブの説明を提供します。

構文

HRESULT SetDescription(
  [in] LPCWSTR Val
);

[in] Val

ジョブに関する追加情報を提供する Null で終わる文字列。文字列の長さは 1,024 文字に制限され、null 終端記号は含まれません。

このメソッドは、次の HRESULT 値と他の値を返します。

リターンコード	説明
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することはできません。