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

  • [アーティクル]

GetPartialFile メソッドは、このコンポーネントに関連付けられている部分ファイルに関する情報を返します。

構文

HRESULT GetPartialFile(
  [in]  UINT iPartialFile,
  [out] BSTR *pbstrPath,
  [out] BSTR *pbstrFilename,
  [out] BSTR *pbstrRange,
  [out] BSTR *pbstrMetadata
);

パラメーター

[in] iPartialFile

部分ファイルのインデックス番号。 このパラメーターの値は、0 から n から 1 までの整数です。 n は、特定のコンポーネントに関連付けられている部分ファイルの合計数です。 n の値は、IVssComponent::GetPartialFileCount によって返されます。

[out] pbstrPath

部分ファイルのパスを含む文字列へのポインター。

このメソッドのユーザーはチェックして、このパスが円記号 ("") で終わるかどうかを判断する必要があります。

[out] pbstrFilename

部分ファイルの名前を含む文字列へのポインター。

[out] pbstrRange

部分的なファイル サポート範囲を構成するファイル オフセットと長さの一覧 (バックアップされたファイルのセクション)、またはそのようなリストを含むファイルの名前を含む文字列へのポインター。

[out] pbstrMetadata

部分的なファイルの復元操作を検証するためにライターが必要とする追加のメタデータを含む文字列へのポインター。 このメタデータ文字列内の情報は、要求者に対して不透明になります。

追加のメタデータは必要ありません。そのため、 pbstrMetadata が空 (長さ 0) の場合もあります。

戻り値

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

値 意味
S_OK
 属性値が正常に返されました。
E_INVALIDARG
 パラメーター値の 1 つが無効です。
E_OUTOFMEMORY
 呼び出し元がメモリ不足またはその他のシステム リソースです。
VSS_E_BAD_STATE
 呼び出し元が、操作の正しい状態 (バックアップまたは復元) ではありません。
VSS_E_INVALID_XML_DOCUMENT
 XML ドキュメントが無効です。 詳細については、イベント ログを確認してください。 詳細については、「 VSS でのイベントとエラーの処理」を参照してください。
VSS_E_OBJECT_NOT_FOUND
 指定された項目が見つかりませんでした。

注釈

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

範囲は、ファイルの残りの部分とは関係なく、バックアップされる特定のファイルのサブセクションを示します。

範囲リスト (pbstrRanges) の構文は、 offset1:length1, offset2:length2 という形式のコンマ区切りリストの構文です。各オフセットと長さは、それぞれバイト オフセットとバイト単位の長さを指定する 64 ビット整数です。 オフセットと長さは、16 進数または 10 進値で表すことができます。

pbstrRanges がすべてのオフセットと長さ (範囲ファイル) を含むファイルを参照する場合、pbstrRanges にはファイルへの完全なパスが含まれている必要があります。

wszRange がすべてのオフセットと長さ (範囲ファイル) を含むファイルを参照する場合、wszRange にはファイルへの完全なパスが含まれている必要があります。

範囲ファイルは、次の形式のバイナリ ファイルである必要があります。

  1. バックアップする必要がある個別のファイル範囲の数を示す 64 ビットの整数。
  2. 各範囲は、64 ビット整数のペアとして表されます。バックアップ対象のファイルへのオフセット (バイト単位)、バックアップするオフセットから始まるデータの長さ。
範囲ファイルは部分ファイルと共にバックアップする必要があり、通常はバックアップ元と同じ場所に復元されます。

ただし、範囲ファイルの復元先の場所はリクエスターによって変更される可能性があります。要求元は、 IVssBackupComponents::SetRangesFilePath を使用してこれを示し、 pbstrRanges が正しい範囲ファイルを示すようにバックアップ コンポーネント ドキュメントを更新します。

要求者は 、GetPartialFile によって返される範囲情報を使用して、バックアップされたセクションを復元時にディスク上のファイルのコピー内の適切な場所に復元します。

要件

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

こちらもご覧ください

IVssBackupComponents::SetRangesFilePath

IVssComponent

IVssComponent::AddPartialFile

IVssComponent::GetPartialFileCount