クラウド フィルター API

Cloud Filter API テクノロジの概要。

Cloud Filter API を開発するには、次のヘッダーが必要です。

• cfapi.h

このテクノロジのプログラミング ガイダンスについては、次を参照してください。

• クラウド フィルター API

列挙型

CF_CALLBACK_CANCEL_FLAGS プレースホルダー ファイルまたはフォルダーのデータフェッチを取り消すコールバック フラグ。
CF_CALLBACK_CLOSE_COMPLETION_FLAGS 以前に読み取り/書き込み/削除アクセス用に開かれた同期ルートの 1 つ下のプレースホルダーが閉じられるようになったことを同期プロバイダーに通知するためのコールバック フラグ。
CF_CALLBACK_DEHYDRATE_COMPLETION_FLAGS 同期ルートの 1 つ下のプレースホルダーが正常に退避されたことを同期プロバイダーに通知するコールバック フラグ。
CF_CALLBACK_DEHYDRATE_FLAGS 同期ルートの 1 つ下のプレースホルダーが退避されることを同期プロバイダーに通知するためのコールバック フラグ。
CF_CALLBACK_DEHYDRATION_REASON クラウド ファイルが脱水された理由を指定します。
CF_CALLBACK_DELETE_COMPLETION_FLAGS プレースホルダーが正常に削除されたことを同期プロバイダーに通知するためのコールバック フラグ。
CF_CALLBACK_DELETE_FLAGS このコールバックは、同期ルートの 1 つ下にあるプレースホルダー ファイルまたはディレクトリが削除または削除されようとしていることを同期プロバイダーに通知するために使用されます。
CF_CALLBACK_FETCH_DATA_FLAGS プレースホルダー ファイルまたはフォルダーのデータをフェッチするためのコールバック フラグ。
CF_CALLBACK_FETCH_PLACEHOLDERS_FLAGS プレースホルダー ファイルまたはディレクトリの内容に関する情報をフェッチするためのフラグ。
CF_CALLBACK_OPEN_COMPLETION_FLAGS 読み取り/書き込み/削除アクセス用にプレースホルダーが正常に開かれたことを同期プロバイダーに通知するためのコールバック フラグ。
CF_CALLBACK_RENAME_COMPLETION_FLAGS 同期ルートの 1 つ下のプレースホルダーの名前が正常に変更されたことを同期プロバイダーに通知するコールバック フラグ。
CF_CALLBACK_RENAME_FLAGS コールバック フラグを呼び出して、同期ルートの 1 つ下のプレースホルダーの名前が変更または移動されようとしていることを同期プロバイダーに通知します。
CF_CALLBACK_TYPE プレースホルダー ファイルまたはフォルダーで使用されるさまざまな種類のコールバックが含まれます。
CF_CALLBACK_VALIDATE_DATA_FLAGS プレースホルダー ファイルまたはディレクトリのデータを検証するためのフラグ。
CF_CONNECT_FLAGS コールバックの呼び出し時に同期プロバイダーが要求できる追加情報。
CF_CONVERT_FLAGS 通常のファイル/ディレクトリからプレースホルダー ファイル/ディレクトリ変換フラグ。
CF_CREATE_FLAGS プレースホルダー ファイルまたはディレクトリを作成するためのフラグ。
CF_DEHYDRATE_FLAGS プレースホルダーの脱水フラグ。
CF_HARDLINK_POLICY プレースホルダー ファイルでハード リンクを許可するかどうかを指定します。
CF_HYDRATE_FLAGS プレースホルダー データハイドレーション フラグ。
CF_HYDRATION_POLICY_MODIFIER 同期プロバイダーが、プラットフォームによってプレースホルダー ファイルをハイドレートする方法を制御できるようにします。 これは、プライマリ ポリシー:_CF_HYDRATION_POLICY_PRIMARYで使用できる修飾子です。
CF_HYDRATION_POLICY_PRIMARY 同期プロバイダーが、プラットフォームによってプレースホルダー ファイルをハイドレートする方法を制御できるようにします。 これがプライマリ ポリシーです。
CF_IN_SYNC_STATE プレースホルダー ファイルとフォルダーの同期中の状態を指定します。
CF_INSYNC_POLICY プラットフォームがプレースホルダー ファイルまたはディレクトリの同期中の状態をクリアするタイミングを同期プロバイダーが制御できるようにするポリシー。
CF_OPEN_FILE_FLAGS ファイルを開くときにさまざまなアクセス許可を要求するフラグ。
CF_OPERATION_ACK_DATA_FLAGS プレースホルダー ファイルまたはフォルダーのデータを確認および確認するためのフラグ。
CF_OPERATION_ACK_DEHYDRATE_FLAGS プレースホルダー ファイルまたはディレクトリの退避を確認するためのフラグ。
CF_OPERATION_ACK_DELETE_FLAGS プレースホルダー ファイルまたはディレクトリの削除を確認するためのフラグ。
CF_OPERATION_ACK_RENAME_FLAGS プレースホルダー ファイルまたはディレクトリ名の変更を確認するためのフラグ。
CF_OPERATION_RESTART_HYDRATION_FLAGS プレースホルダー ファイルまたはフォルダーのデータハイドレーションを再開するためのフラグ。
CF_OPERATION_RETRIEVE_DATA_FLAGS プレースホルダー ファイルまたはフォルダーのデータを取得するためのフラグ。
CF_OPERATION_TRANSFER_DATA_FLAGS プレースホルダー ファイルまたはフォルダーをハイドレートするためにデータを転送するためのフラグ。
CF_OPERATION_TRANSFER_PLACEHOLDERS_FLAGS プレースホルダー ファイルまたはディレクトリを転送するときの動作を指定するフラグ。
CF_OPERATION_TYPE プレースホルダー ファイルとディレクトリに対して実行できる操作の種類。
CF_PIN_STATE プレースホルダー ファイルまたはディレクトリの状態をピン留めします。
CF_PLACEHOLDER_CREATE_FLAGS プレースホルダーごとにプレースホルダーを作成するためのフラグ。
CF_PLACEHOLDER_INFO_CLASS プレースホルダー情報の情報クラス。
CF_PLACEHOLDER_MANAGEMENT_POLICY CF_SYNC_POLICIES構造のプレースホルダー管理ポリシーを指定します。
CF_PLACEHOLDER_RANGE_INFO_CLASS プレースホルダー ファイル データの範囲の型。
CF_PLACEHOLDER_STATE プレースホルダー ファイルまたはフォルダーの状態。
CF_POPULATION_POLICY_MODIFIER 作成ポリシー修飾子を定義します。 これは、プライマリ ポリシー:_CF_POPULATION_POLICY_PRIMARYで使用できる修飾子です。
CF_POPULATION_POLICY_PRIMARY 同期プロバイダーが、プラットフォームでプレースホルダー ディレクトリとファイルを作成する方法を制御できるようにします。 これがプライマリ ポリシーです。
CF_REGISTER_FLAGS 同期ルートを登録および更新するためのフラグ。
CF_REVERT_FLAGS プレースホルダー ファイルを通常のファイルに戻すフラグ。
CF_SET_IN_SYNC_FLAGS プレースホルダー ファイルとフォルダーの同期中状態フラグ。
CF_SET_PIN_FLAGS プレースホルダーのピン フラグ。
CF_SYNC_PROVIDER_STATUS 同期プロバイダーの現在の状態。
CF_SYNC_ROOT_INFO_CLASS 同期ルート情報の種類。
CF_UPDATE_FLAGS プレースホルダー ファイルまたはディレクトリを更新するためのフラグ。

関数

CfCloseHandle CfOpenFileWithOplock によって返されたファイルまたはディレクトリ ハンドルを閉じます。 これは、CfApi.h 内で使用されるハンドルでのみ、標準の Win32 ファイル ハンドルでは使用しないでください。
CfConnectSyncRoot 同期プロバイダーと同期フィルター API の間の双方向通信を開始します。
CfConvertToPlaceholder 通常のファイル/ディレクトリをプレースホルダー ファイル/ディレクトリに変換します。
CfCreatePlaceholders 同期ルート ツリーの下に 1 つ以上の新しいプレースホルダー ファイルまたはディレクトリを作成します。
CfDisconnectSyncRoot CfConnectSyncRoot によって作成された通信チャネルを切断します。
CfExecute すべての接続キー ベースのプレースホルダー操作のメイン エントリ ポイント。 これは、プラットフォームからのさまざまなコールバックに応答するために同期プロバイダーによって使用されることを目的としています。
CfGetCorrelationVector 同期プロバイダーが、特定のプレースホルダー ファイルに対して現在の相関ベクトルに対してクエリを実行できるようにします。
CfGetPlaceholderInfo プレースホルダー ファイルまたはフォルダーのさまざまな特性を取得します。
CfGetPlaceholderRangeInfo プレースホルダー ファイルまたはフォルダーに関する範囲情報を取得します。
CfGetPlaceholderRangeInfoForHydration ConnectionKey、TransferKey、FileId を識別子として使用して、プレースホルダー ファイルまたはフォルダーに関する範囲情報を取得します。
CfGetPlaceholderStateFromAttributeTag ファイルの FileAttributes 値と ReparseTag 値に基づいて、一連のプレースホルダーの状態を取得します。
CfGetPlaceholderStateFromFileInfo ファイルのさまざまな情報に基づいて、プレースホルダーの状態のセットを取得します。
CfGetPlaceholderStateFromFindData WIN32_FIND_DATA構造体に基づいてプレースホルダーの状態のセットを取得します。
CfGetPlatformInfo プラットフォームのバージョン情報を取得します。
CfGetSyncRootInfoByHandle ファイル ハンドルによって指定された特定のファイルを含む同期ルートのさまざまな特性を取得します。
CfGetSyncRootInfoByPath 同期ルートの下にあるファイルを指定して、さまざまな同期ルート情報を取得します。
CfGetTransferKey プレースホルダー ファイルまたはフォルダーへのデータの転送を開始します。
CfGetWin32HandleFromProtectedHandle 保護されたハンドルを Win32 ハンドルに変換して、すべてのハンドル ベースの Win32 API で使用できるようにします。
CfHydratePlaceholder 指定したバイト範囲がプレースホルダーにディスク上に存在することを確認して、プレースホルダー ファイルをハイドレートします。 これは、ファイルに対してのみ有効です。
CfOpenFileWithOplock (通常のファイルとプレースホルダー ファイルの両方の) ファイルまたはディレクトリへの非同期不透明ハンドルを開き、開いているフラグに基づいて適切な oplock を設定します。
CfQuerySyncProviderStatus 同期プロバイダーに対してクエリを実行して、プロバイダーの状態を取得します。
CfReferenceProtectedHandle 呼び出し元が保護されたハンドルを、CfApi 以外の Win32 API で使用できる Win32 ハンドルに参照できるようにします。
CfRegisterSyncRoot 1 回限りの同期ルート登録を実行します。
CfReleaseProtectedHandle CfReferenceProtectedHandle によって参照される保護されたハンドルを解放します。
CfReleaseTransferKey CfGetTransferKey によって取得された転送キーを解放します。
CfReportProviderProgress 同期プロバイダーが帯域外の進行状況を報告できるようにします。
CfReportProviderProgress2 同期プロバイダーが帯域外の進行状況を報告できるようにします。 CfReportProviderProgress を追加のパラメーターで拡張します。
CfReportSyncStatus 最初に CfConnectSyncRoot の呼び出しに接続しなくても、同期プロバイダーが指定した同期ルートの状態をプラットフォームに通知できるようにします。
CfRevertPlaceholder プレースホルダーを通常のファイルに戻し、再解析タグ、ファイル ID などの特殊な特性をすべて取り除きます。
CfSetCorrelationVector 同期プロバイダーが、プレースホルダー ファイルでテレメトリの目的で特定の相関ベクトルを使用するようにプラットフォームに指示できるようにします。 これは省略可能です。
CfSetInSyncState プレースホルダー ファイルまたはフォルダーの同期中の状態を設定します。
CfSetPinState これにより、ユーザーの意図を表すために使用されるプレースホルダーのピンの状態が設定されます。 (同期プロバイダーだけでなく) どのアプリケーションでも、この関数を呼び出すことができます。
CfUnregisterSyncRoot 以前に登録された同期ルートの登録を解除します。
CfUpdatePlaceholder プレースホルダー ファイルまたはディレクトリの特性を更新します。
CfUpdateSyncProviderStatus 同期プロバイダーの現在の状態を更新します。

構造体

CF_CALLBACK_INFO 一般的なコールバック情報が含まれています。
CF_CALLBACK_PARAMETERS ファイル オフセット、長さ、フラグなどのコールバック固有のパラメーターが含まれます。
CF_CALLBACK_REGISTRATION 同期プロバイダーによって登録されるコールバック。
CF_FILE_RANGE プレースホルダー ファイル内のデータの範囲を指定します。
CF_FS_METADATA プレースホルダー ファイルまたはディレクトリ メタデータ。
CF_HYDRATION_POLICY プライマリ ハイドレーション ポリシーとその修飾子を指定します。
CF_OPERATION_INFO プレースホルダー ファイルまたはフォルダーに対する操作に関する情報。
CF_OPERATION_PARAMETERS プレースホルダー ファイルまたはフォルダーに対する操作のパラメーター。
CF_PLACEHOLDER_BASIC_INFO 基本的なプレースホルダー情報。
CF_PLACEHOLDER_CREATE_INFO 新しいプレースホルダー ファイルまたはディレクトリを作成するためのプレースホルダー情報が含まれています。
CF_PLACEHOLDER_STANDARD_INFO 標準のプレースホルダー情報。
CF_PLATFORM_INFO クラウド ファイル プラットフォームの情報を返します。 これは、複数のバージョンの Windows で実行されている同期プロバイダーを対象としています。
CF_POPULATION_POLICY プライマリ作成ポリシーとその修飾子を指定します。
CF_PROCESS_INFO ユーザー プロセスに関する情報が含まれます。
CF_SYNC_POLICIES 同期ルートによって使用される同期ポリシーを定義します。
CF_SYNC_REGISTRATION 登録する同期プロバイダーと同期ルートの詳細。
CF_SYNC_ROOT_BASIC_INFO 基本的な同期ルート情報。
CF_SYNC_ROOT_PROVIDER_INFO ルート プロバイダー情報を同期します。
CF_SYNC_ROOT_STANDARD_INFO 標準同期ルート情報。
CF_SYNC_STATUS 指定した同期ルートの状態を記述するために、CF_OPERATION_INFO構造体で使用されます。