Share via

SisCSFilesToBackupForLink 関数

  • [アーティクル]

SisCSFilesToBackupForLink 関数は、指定された SIS リンクが指す共通ストア ファイルを記述する情報を返します。

構文

BOOL SisCSFilesToBackupForLink(
  _In_  PVOID  sisBackupStructure,
  _In_  PVOID  reparseData,
  _In_  ULONG  reparseDataSize,
  _Out_ PVOID  thisFileContext,
  _Out_ PVOID  *matchingFileContext,
  _Out_ PULONG countOfCommonStoreFilesToBackUp,
  _Out_ PWCHAR **commonStoreFilesToBackUp
);

パラメーター

sisBackupStructure [in]

SisCreateBackupStructure から返される SIS バックアップ構造へのポインター。

reparseData [in]

SIS 再解析ポイントの内容へのポインター。 この再解析ポイントには、SIS リンクを記述するデータが含まれています。 ファイルの再解析ポイント データを取得するには、 FSCTL_GET_REPARSE_POINT コントロール コードを使用します。

reparseDataSize [in]

reparseData によって指される SIS 再解析ポイントの内容のサイズ (バイト単位)。

thisFileContext [out]

この関数を呼び出すバックアップ アプリケーションによって提供されるコンテキスト文字列へのポインター。 このコンテンツ文字列の内容は、このバックアップ アプリケーションによって完全に決定され、SIS Backup API によって解釈されません。 このパラメーターは省略可能です。使用しない場合は、このパラメーターの値を NULL に設定 します。 この場合、このパラメーターの値は処理されません。

matchingFileContext [out]

この関数の最初の 4 つのパラメーターで渡された情報によって識別される SIS リンクのコンテキスト文字列への二重間接ポインター。 このパラメーターは省略可能です。コンテキスト文字列が thisFileContext パラメーターの値として指定されていない場合は、このパラメーターの値を NULL に設定 します。 この場合、このパラメーターの値は処理されません。

countOfCommonStoreFilesToBackUp [out]

commonStoreFilesToBackUp パラメーターに一覧表示されているファイルの数。

commonStoreFilesToBackUp [out]

ファイル名の配列へのポインター。 これらのファイルは、 SisCreateBackupStructure によって要求された共通ストア ファイルと同じ方法で、同時にバックアップする必要があります。

戻り値

この関数は、正常に完了した場合は TRUE を返し、それ以外の場合は FALSE を 返します。 GetLastError を呼び出して、呼び出しが失敗した理由の詳細を取得します。

注釈

バックアップ アプリケーションは、バックアップ対象の SIS リンク ファイルごとに 1 回だけこの関数を呼び出す必要があります。

バックアップ アプリケーションは、SIS 再解析ポイントをタグ (IO_REPARSE_TAG_SIS) で識別できます。 このタグは Winnt.h で定義されています。

reparseData パラメーターの値で識別されるこの再解析ポイントで、バックアップするファイルの最初のインスタンスが記述されている場合、この関数は matchingFileContext パラメーターの値として NULL を返し、バックアップする共通ストア ファイルまたはファイルの名前を使用して文字列の commonStoreFilesToBackUp 配列の値を初期化します。 それ以外の場合、この関数は matchingFileContext パラメーターの値を、指定したファイルの最初のインスタンスに対応するコンテキスト文字列に設定し、 countOfCommonStoreFilesToBackUp パラメーターの値を 0 に設定します。 指定したリンクに対応する複数の共通ストア ファイルがある場合、 thisFileContext パラメーターの値は、配列で返される最初の共通ストア ファイル (commonStoreFilesToBackUp[0]) に対応するコンテキスト文字列になります。

この関数の現在のバージョンでは、最大で 1 つの共通ストア ファイルが返されますが、将来のバージョンでは、1 つのリンクが複数の共通ストア ファイルによってサポートされる可能性があります。たとえば、ファイル内のストリームごとに 1 つずつ、バックアップ アプリケーションでこの関数の呼び出しごとに複数のファイルをサポートする必要があります。 いずれの場合も、各共通ストア ファイルは、バックアップ パスごとに最大 1 回返されます。

バックアップ アプリケーションでは、 commonStoreFilesToBackUp パラメーターで返されるファイル名またはファイル名で識別される共通ストア ファイルまたはファイルをバックアップまたは復元する必要があります。 対応する共通ストア ファイルがあるかどうかに関係なく、バックアップ アプリケーションは SIS リンク ファイルをディスク上に存在する SIS リンク ファイル (たとえば、再解析ポイントとスパース ファイルなど) としてバックアップする必要があり、ほとんどの場合は範囲が入力されません。 バックアップ アプリケーションでは、共通ストア ファイルまたはファイルをすぐにバックアップまたは復元したり、バックアップを延期したり、必要に応じてそれらを混在させたりすることができます。

バックアップ操作が完了したら、SisFreeAllocatedMemory を呼び出して、文字列の commonStoreFilesToBackUp 配列で使用されるメモリの割り当てを解除します。

要件

要件 値
サポートされている最小のクライアント
 Windows XP [デスクトップ アプリのみ]
サポートされている最小のサーバー
 Windows Server 2003 [デスクトップ アプリのみ]
Header
Sisbkup.h
ライブラリ
Sisbkup.lib
[DLL]
Sisbkup.dll

こちらもご覧ください

SisFreeAllocatedMemory

SisCreateBackupStructure