IVssComponent::GetBackupStamp メソッド (vswriter.h)

  • [アーティクル]

GetBackupStamp メソッドは、特定のコンポーネントのライターによって格納されているバックアップ スタンプ文字列を返します。

ライターまたはリクエスターは、このメソッドを呼び出すことができます。

構文

HRESULT GetBackupStamp(
  [out] BSTR *pbstrBackupStamp
);

パラメーター

[out] pbstrBackupStamp

コンポーネントがバックアップされた時刻を示すバックアップ スタンプを含む文字列を受け取る呼び出し元割り当て変数のアドレス。

戻り値

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

値 説明
S_OK
 属性値が正常に返されました。
S_FALSE
 このコンポーネントに関連付けられているタイム スタンプはありません。
E_INVALIDARG
 パラメーター値の 1 つが無効です。
E_OUTOFMEMORY
 呼び出し元がメモリやその他のシステム リソースを使い切れている。
VSS_E_INVALID_XML_DOCUMENT
 XML ドキュメントが無効です。 詳細については、イベント ログを確認してください。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。

解説

バックアップ タイムスタンプが設定されていない場合、 GetBackupStamp はS_FALSEを返します。

GetBackupStamp の呼び出しが成功した場合、呼び出し元は SysFreeString 関数を呼び出して pbstrBackupStamp パラメーターで返される文字列を解放します。

返される文字列は、コンポーネント内のすべてのファイルと、コンポーネントが持つ選択できないサブコンポーネントを参照します。

GetBackupStamp によって取得されるバックアップ スタンプは、通常、PostSnapshot イベント ハンドラー CVssWriter::OnPostSnapshot 内から IVssComponent::SetBackupStamp を呼び出すことによってライターによって設定されます。

要求者はバックアップ スタンプをバックアップ コンポーネント ドキュメントに格納するだけです。バックアップ スタンプを直接使用したり、それを生成する方法を知ったり、その形式を理解したりすることはありません。

要件

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

関連項目

IVssBackupComponents::SetPreviousBackupStamp

IVssComponent

IVssComponent::SetBackupStamp