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することはできません。

要件

要件 値
サポートされている最小のクライアント Windows XP
サポートされている最小のサーバー Windows Server 2003
対象プラットフォーム Windows
ヘッダー bits.h
Library Bits.lib
[DLL] QmgrPrxy.dll

こちらもご覧ください

IBackgroundCopyJob::GetDescription