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

  • [アーティクル]

ジョブの状態を取得します。

構文

HRESULT GetState(
  [out] BG_JOB_STATE *pVal
);

パラメーター

[out] pVal

ジョブの状態。 たとえば、状態には、ジョブがエラーであるか、データが転送されているか、中断されているかが反映されます。 ジョブの状態の一覧については、 BG_JOB_STATE 列挙を参照してください。

戻り値

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

リターン コード 説明
S_OK
 ジョブの状態が正常に取得されました。
E_INVALIDARG
 パラメーター pJobState を NULL にすることはできません。

注釈

ジョブがエラーになっているか、ジョブ内のすべてのファイルが転送されたことを知りたい場合は、このメソッドを使用してジョブの状態をポーリングするか、登録してイベントが発生したときに通知を受け取ることができます。 イベント通知を受信するための登録の詳細については、 IBackgroundCopyCallback インターフェイスを参照してください。

例

IBackgroundCopyManager::GetJob メソッドのコード例を参照してください。

要件

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

こちらもご覧ください

BG_JOB_STATE、 ジョブの状態の決定、 IBackgroundCopyCallback