CVssWriter::OnIdentify メソッド (vswriter.h)

  • [アーティクル]

OnIdentify メソッドは、Identify イベントの受信後にライターによって呼び出されます。

OnIdentify は仮想メソッドです。 これは CSVsWriter 基底クラスによって実装されますが、派生クラスによってオーバーライドできます。

構文

bool OnIdentify(
  [in] IVssCreateWriterMetadata *pMetadata
);

パラメーター

[in] pMetadata

ライターのメタデータを構築するために使用される IVssCreateWriterMetadata オブジェクトへのポインター。

戻り値

基底クラスによって実装されているように、 OnIdentify は常に true を返します。

致命的なエラーが発生した場合を除き、このメソッドの他の実装は true を返す必要があります。 致命的なエラーが発生した場合、メソッドは false を返す必要があります。

致命的でないエラーを含め、エラーが発生した場合、メソッドはイベント ログに詳細なエントリを書き込み、エラーの正確な理由を報告する必要があります。

注釈

CVssWriter 基本クラスによるこのメソッドの既定の実装は、他の操作を実行せずに true を返します。

ライターは、このメソッドまたは他の CSVSWriter(Ex)::OnXxx コールバック メソッドから例外をスローしないでください。

ライターは、OnIdentify メソッドまたは CVssWriterEx::OnIdentifyEx メソッドから CVssWriter::SetWriterFailure メソッドを呼び出さないでください。

このメソッドが CVssWriterEx2::GetSessionId メソッドを呼び出す場合は、このメソッドを呼び出したのと同じスレッドで呼び出す必要があります。 詳細については、「 ライター イベント処理」を参照してください。

別のアプリケーションによって生成された Identify イベントに応答して、ライターは OnIdentify ハンドラーを使用して、 IVssCreateWriterMetadata インターフェイスを使用して管理するコンポーネントに関する情報を含むライター メタデータ ドキュメントを作成します。

Identify イベントを生成したアプリケーションは、ライター メタデータ ドキュメントを取得し、 IVssExamineWriterMetadata インターフェイスを使用してライターのコンポーネント情報を調べます。

バックアップまたは復元シーケンスを構成するイベントの前に Identify イベントが必要です。 そのため、 OnIdentify は、バックアップ操作または復元操作の一部として要求者が IVssBackupComponents::GatherWriterMetadata を呼び出した場合に応答して Identify イベントを処理するために、おそらく最も一般的に呼び出されます。

ただし、Identify イベント自体は、バックアップまたは復元を構成する一連のイベントの一部ではなく、バックアップまたは復元シーケンスが進行中であっても VSS サービスによって生成が妨げられません。 たとえば、VSS 管理アプリケーションは Identify イベントを使用して、システム上のライターの状態を決定して表示します。

この場合、ライターは次の方法で OnIdentify の実装を使用しないでください。

  • バックアップまたは復元の処理の始まりとして
  • ライターの状態に関する情報を設定または維持するには
イベントとのライター操作の詳細については、「 ライター イベント処理 」を参照してください。

OnIdentify に渡される IVssCreateWriterMetadata オブジェクトのライフ サイクルは、VSS インフラストラクチャによって管理されます。

要件

要件 値
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー vswriter.h (Vss.h、VsWriter.h を含む)
Library VssApi.lib

こちらもご覧ください

CSVSWriter

IVssBackupComponents::GatherWriterMetadata

IVssCreateWriterMetadata