IVssBackupComponentsEx::GetWriterMetadataEx メソッド (vsbackup.h)
GetWriterMetadataEx メソッドは、システムで実行されている特定のライター インスタンスのメタデータを返します。
構文
HRESULT GetWriterMetadataEx(
[in] UINT iWriter,
[out] VSS_ID *pidInstance,
[out] IVssExamineWriterMetadataEx **ppMetadata
);
パラメーター
[in] iWriter
メタデータを取得するライターのインデックス。 このパラメーターの値は、0 から n から 1 までの整数です。 ここで、n は現在のシステム上のライターの合計数です。 n の値は、IVssBackupComponents::GetWriterMetadataCount メソッドによって返されます。
[out] pidInstance
メタデータを収集したライターのインスタンス識別子を受け取る呼び出し元によって割り当てられた変数のアドレス。
[out] ppMetadata
返されたメタデータを含む IVssExamineWriterMetadataEx オブジェクトのインスタンスへの二重間接ポインター。
戻り値
このメソッドの有効なリターン コードを次に示します。
| 値 | 意味 |
|---|---|
|
IVssExamineWriterMetadataEx インターフェイス オブジェクトへのポインターが正常に返されました。 |
|
パラメーター値の 1 つが無効です。 |
|
呼び出し元がメモリ不足またはその他のシステム リソースです。 |
|
バックアップ コンポーネント オブジェクトが初期化されていないか、復元操作中にこのメソッドが呼び出されたか、このメソッドが正しいシーケンス内で呼び出されていません。 |
|
XML ドキュメントが無効です。 詳細については、イベント ログを確認してください。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。 |
|
iWriter パラメーターは、有効なライターを指していません。 |
|
予期しないエラー。 エラー コードはエラー ログ ファイルに記録されます。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。
Windows Server 2008、Windows Vista、Windows Server 2003、Windows XP: この値は、Windows Server 2008 R2 および Windows 7 まではサポートされません。 代わりに、E_UNEXPECTEDが使用されます。 |
注釈
GetWriterMetadataEx は IVssBackupComponents::GetWriterMetadata メソッドと同じですが、ppMetadata パラメーターの IVssExamineWriterMetadata インターフェイス ポインターの代わりに IVssExamineWriterMetadataEx インターフェイス ポインターを返す点が除きます。
要求元は、非同期 IVssBackupComponents::GatherWriterMetadata メソッドを呼び出し、 GetWriterMetadataEx を呼び出す前に完了するまで待機する必要があります。
GatherWriterMetadata メソッドは、復元操作またはバックアップ操作の前に呼び出す必要がありますが、通常、復元には GetWriterMetadataEx は呼び出されません。
IVssExamineWriterMetadata::GetComponent メソッドを使用して (バックアップ操作中に) 取得されたコンポーネント情報。IVssExamineWriterMetadataEx インターフェイスが GetWriterMetadataEx によって返された場合、ライブ ライター プロセスのライター メタデータ ドキュメントから取得されます。
これは、 IVssBackupComponents::AddComponent メソッドの呼び出しによってバックアップ コンポーネント ドキュメントに格納された GetWriterComponents によって (復元操作中に) 返される情報とは対照的です。
このメソッドの呼び出し元がメタデータへのアクセスを完了したら、 IUnknown::Release を呼び出す必要があります。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows Vista [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008、Windows Server 2003 SP1 [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | vsbackup.h (VsBackup.h、Vss.h、VsWriter.h を含む) |
| Library | VssApi.lib |