IVssExamineWriterMetadata::GetIdentity メソッド (vsbackup.h)

  • [アーティクル]

GetIdentity メソッドは、特定のライター インスタンスに関する基本情報を取得します。

構文

HRESULT GetIdentity(
  [out] VSS_ID          *pidInstance,
  [out] VSS_ID          *pidWriter,
  [out] BSTR            *pbstrWriterName,
  [out] VSS_USAGE_TYPE  *pUsage,
  [out] VSS_SOURCE_TYPE *pSource
);

パラメーター

[out] pidInstance

ライターのインスタンス識別子を受け取る呼び出し元によって割り当てられた変数のアドレス。

[out] pidWriter

ライターのクラス識別子を受け取る呼び出し元によって割り当てられた変数のアドレス。

[out] pbstrWriterName

ライターの名前を含む文字列を受け取る呼び出し元によって割り当てられた変数のアドレス。

[out] pUsage

ライターによって管理されるデータをホスト システムで使用する方法を指定する VSS_USAGE_TYPE 列挙値を受け取る呼び出し元によって割り当てられた変数のアドレス。

[out] pSource

ライターによって管理されるデータの種類を指定する VSS_SOURCE_TYPE 列挙値を受け取る呼び出し元によって割り当てられた変数のアドレス。

戻り値

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

値 意味
S_OK
 ID 情報が正常に返されました。
E_INVALIDARG
 パラメーター値の 1 つが無効です。
E_OUTOFMEMORY
 呼び出し元がメモリやその他のシステム リソースを使い切れている。
VSS_E_INVALID_XML_DOCUMENT
 XML ドキュメントが無効です。 詳細については、イベント ログを確認してください。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。
VSS_E_UNEXPECTED
 予期しないエラー。 エラー コードは、エラー ログ ファイルに記録されます。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。

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

注釈

呼び出し元は、SysFreeString を呼び出すことによって、pbstrWriterName パラメーターによって保持されているメモリを解放する必要があります。

IVssExamineWriterMetadata インターフェイスは、格納されているライター状態情報 (CreateVssExamineWriterMetadata の呼び出しによって作成) から取得される場合があります。 この場合、次のことが当てはまります。

  • pidInstance は、ライブ ライターの観点から何も意味しない可能性があります。
  • pidWriter がライブ ライターのライター クラスと一致しない場合、リクエスターはそのライターのコンポーネントを使用しないでください。

要件

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

こちらもご覧ください

CreateVssExamineWriterMetadata

IVssExamineWriterMetadata

VSS_SOURCE_TYPE

VSS_USAGE_TYPE