ジョブの状態を取得します。
構文
HRESULT GetState(
[out] BG_JOB_STATE *pVal
);
パラメーター
[out] pVal
ジョブの状態。 たとえば、ジョブがエラーになっているか、データを転送しているか、中断されているかが状態に反映されます。 ジョブの状態の一覧については、 BG_JOB_STATE 列挙型を参照してください。
戻り値
このメソッドは、次の HRESULT 値と他の値を返します。
| リターン コード | Description |
|---|---|
|
ジョブの状態が正常に取得されました。 |
|
パラメーター pJobState を NULL にすることはできません。 |
注釈
ジョブがいつエラーになっているか、ジョブ内のすべてのファイルを転送したかを知りたい場合は、このメソッドを使用してジョブの状態をポーリングするか、イベントが発生したときに通知を受け取るために登録することができます。 イベント通知を受信するための登録の詳細については、 IBackgroundCopyCallback インターフェイスを参照してください。
例示
IBackgroundCopyManager::GetJob メソッドのコード例を参照してください。
Requirements
| Requirement | 価値 |
|---|---|
| サポートされる最小クライアント | Windows XP |
| サポートされている最小のサーバー | Windows Server 2003 |
| ターゲット プラットフォーム の | ウィンドウズ |
| Header | bits.h |
| Library | Bits.lib |
| DLL | QmgrPrxy.dll |