IBackgroundCopyJob::GetState メソッド
ジョブの状態を取得します。
構文
HRESULT GetState(
[out] BG_JOB_STATE *pJobState
);
パラメーター
-
pJobState [out]
-
ジョブの状態。 たとえば、状態には、ジョブがエラーであるか、データが転送されているか、中断されているかが反映されます。 ジョブの状態の一覧については、 BG_JOB_STATE 列挙を参照してください。
戻り値
このメソッドは、次の HRESULT 値と他の値を返します。
| リターン コード | 説明 |
|---|---|
|
ジョブの状態が正常に取得されました。 |
解説
ジョブがエラーになっているか、ジョブ内のすべてのファイルが転送されたことを知りたい場合は、このメソッドを使用してジョブの状態をポーリングするか、登録してイベントが発生したときに通知を受け取ることができます。 イベント通知を受信するための登録の詳細については、 IBackgroundCopyCallback インターフェイスを参照してください。
必要条件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント |
Windows 10、バージョン 1709 [デスクトップ アプリのみ] |
| サポートされている最小のサーバー |
Windows Server バージョン 1709 [デスクトップ アプリのみ] |
| Header |
|
| IDL |
|
| ライブラリ |
|
| [DLL] |
|
| IID |
IID_IBackgroundCopyJobは 37668D37-507E-4160-9316-26306D150B12 として定義されています |