IVssBackupComponents::GetWriterMetadata メソッド (vsbackup.h)

GetWriterMetadata メソッドは、システムで実行されている特定のライターのメタデータを返します。

構文

HRESULT GetWriterMetadata(
  [in]  UINT                      iWriter,
  [out] VSS_ID                    *pidInstance,
  [out] IVssExamineWriterMetadata **ppMetadata
);

パラメーター

[in] iWriter

メタデータを取得するライターのインデックス。 このパラメーターの値は、0 から n から 1 までの整数です。 ここで、n は現在のシステム上のライターの合計数です。 n の値は、IVssBackupComponents::GetWriterMetadataCount によって返されます。

[out] pidInstance

メタデータを収集したライターのインスタンス識別子へのポインター。

[out] ppMetadata

返されたメタデータを含む IVssExamineWriterMetadata オブジェクトのインスタンスへの二重間接ポインター。

戻り値

このメソッドの有効なリターン コードを次に示します。

意味
S_OK
IVssExamineWriterMetadata インターフェイス オブジェクトへのポインターが正常に返されました。
E_INVALIDARG
パラメーター値の 1 つが無効です。
E_OUTOFMEMORY
呼び出し元がメモリ不足またはその他のシステム リソースです。
VSS_E_BAD_STATE
バックアップ コンポーネント オブジェクトが初期化されていないか、復元操作中にこのメソッドが呼び出されたか、このメソッドが正しいシーケンス内で呼び出されていません。
VSS_E_INVALID_XML_DOCUMENT
XML ドキュメントが無効です。 詳細については、イベント ログを確認してください。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。
VSS_E_OBJECT_NOT_FOUND
指定されたシャドウ コピーが存在しません。
VSS_E_UNEXPECTED
予期しないエラー。 エラー コードはエラー ログ ファイルに記録されます。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。

Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: この値は、Windows Server 2008 R2 および Windows 7 まではサポートされません。 代わりに、E_UNEXPECTEDが使用されます。

注釈

要求者は非同期操作 IVssBackupComponents::GatherWriterMetadata を呼び出し、 GetWriterMetadata を呼び出す前に完了するまで待機する必要があります。

復元操作またはバックアップ操作の前に IVssBackupComponents::GatherWriterMetadata を呼び出す必要がありますが、 通常、復元には GetWriterMetadata は呼び出されません。

IVssExamineWriterMetadata::GetComponent を使用して (バックアップ操作中に) 取得されたコンポーネント情報。ここで、IVssExamineWriterMetadata インターフェイスはライブ ライター プロセスのライター メタデータ ドキュメントから取得されます。

これは、AddComponent の呼び出しによってバックアップ コンポーネント ドキュメントに格納された GetWriterComponents によって (復元操作中に) 返される情報とは対照的 です

このメソッドの呼び出し元がメタデータへのアクセスを完了したら、 IUnknown::Release を呼び出す必要があります。

要件

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

こちらもご覧ください

IVssBackupComponents

IVssBackupComponents::AddComponent

IVssBackupComponents::GatherWriterMetadata

IVssBackupComponents::GetWriterComponents

IVssBackupComponents::GetWriterMetadataCount

IVssExamineWriterMetadata