IBackgroundCopyJob::SetDisplayName メソッド (bits.h)
ジョブの表示名を指定します。 通常、表示名を使用して、ユーザー インターフェイスでジョブを識別します。
構文
HRESULT SetDisplayName(
[in] LPCWSTR Val
);
パラメーター
[in] Val
ジョブを識別する Null で終わる文字列。 NULL にすることはできません。 文字列の長さは 256 文字に制限され、null 終端記号は含まれません。
戻り値
このメソッドは、次の HRESULT 値と他の値を返します。
| リターン コード | 説明 |
|---|---|
|
表示名が正常に設定されました。 |
|
pDisplayName パラメーターを NULL にすることはできません。または、名前が 256 文字を超えています。 |
|
表示名が 256 文字を超えています。 |
|
ジョブの状態をBG_JOB_STATE_CANCELLEDまたはBG_JOB_STATE_ACKNOWLEDGEDすることはできません。 |
注釈
表示名は、ジョブの作成時に最初に設定されます。 ジョブの作成時に表示名を指定する方法の詳細については、 IBackgroundCopyManager::CreateJob メソッドを参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP |
| サポートされている最小のサーバー | Windows Server 2003 |
| 対象プラットフォーム | Windows |
| ヘッダー | bits.h |
| Library | Bits.lib |
| [DLL] | QmgrPrxy.dll |