Win32 API 日本語リファレンス
ホームStorage.CloudFilters › CF_SYNC_POLICIES

CF_SYNC_POLICIES

構造体
サイズx64: 24 バイト / x86: 24 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
StructSizeDWORD4+0+0CF_SYNC_POLICIES 構造体のサイズです。
HydrationCF_HYDRATION_POLICY4+4+4

ハイドレーションポリシーを使用すると、同期プロバイダーはプレースホルダーファイルをプラットフォームがどのようにハイドレートするかを制御できます。このポリシーは、1 つのプライマリポリシーと一連のポリシー修飾子で構成されます。

プライマリポリシーには次の 4 つの値があります。

ポリシー 説明
ALWAYS_FULL ALWAYS_FULL を選択すると、完全にはハイドレートされていないプレースホルダーが生じる可能性のあるプレースホルダー操作は、プラットフォームによって HRESULT ERROR_CLOUD_FILE_INVALID_REQUEST で失敗します。これには CfCreatePlaceholdersCfDehydratePlaceholderdehydrate オプションを指定した CfUpdatePlaceholder、および dehydrate オプションを指定した CfConvertPlaceholder が含まれます。
FULL FULL を選択すると、プラットフォームはプレースホルダーのデハイドレートを許可します。デハイドレートされたプレースホルダーへのアクセスを検出した場合、プラットフォームは、要求がわずか 1 バイトであっても、ユーザーの IO 要求を完了する前にプレースホルダーの完全な内容がローカルで利用可能になるようにします。
PROGRESSIVE PROGRESSIVE を選択すると、プラットフォームはプレースホルダーのデハイドレートを許可します。デハイドレートされたプレースホルダーへのアクセスを検出した場合、プラットフォームは同期プロバイダーから十分なデータを受け取ったと判断した時点でユーザーの IO 要求を完了します。ただしプラットフォームは、プレースホルダーの完全な内容がローカルで利用可能になるか、プレースホルダーに対する最後のユーザーハンドルが閉じられるまで、バックグラウンドで残りの内容を同期プロバイダーに要求し続けます。

PROGRESSIVE を選択した同期プロバイダーは、ハイドレーションコールバックがオフセット 0 から順番に到着するとは想定できない点に注意してください。つまり、PROGRESSIVE ポリシーを使用する同期プロバイダーは、プレースホルダーに対するランダムなシークを処理できる必要があります。
PARTIAL PARTIAL ポリシーは PROGRESSIVE と非常によく似ています。両者の唯一の違いは、PARTIAL ポリシーではバックグラウンドでの継続的なハイドレーションが行われない点です。

現在、VALIDATION_REQUIREDSTREAMING_ALLOWEDAUTO_DEHYDRATION_ALLOWED の 3 つのポリシー修飾子がサポートされています。一般に、組み合わせが相互に矛盾しない限り、修飾子は任意のプライマリポリシーや他のポリシー修飾子と自由に組み合わせられます。

ポリシー修飾子 説明
VALIDATION_REQUIRED このポリシー修飾子は、同期プロバイダーに 2 つの保証を提供します。1 つ目は、同期プロバイダーが返したデータが、ユーザーアプリケーションに返される前に必ずディスクへ永続化されることです。2 つ目は、同期プロバイダーが以前にプラットフォームへ返したデータと同じデータを取得し、その整合性を検証できることです。同期プロバイダーが整合性を確認して初めて、プラットフォームはユーザーの IO 要求を完了します。この修飾子は、追加のディスク IO と引き換えに、エンドツーエンドのデータ整合性をサポートします。
STREAMING_ALLOWED このポリシー修飾子は、同期プロバイダーが返したデータをローカルディスクに保存しないことをプラットフォームに許可します。このポリシー修飾子は VALIDATION_REQUIRED と相互排他的です。両方のフラグが指定された場合、API は ERROR_INVALID_PARAMETER で失敗します。
AUTO_DEHYDRATION_ALLOWED このポリシー修飾子は、同期プロバイダーの助けなしに同期済みのクラウドファイルプレースホルダーをデハイドレートすることをプラットフォームに許可します。このフラグがない場合、プラットフォームは CfDehydratePlaceholder を直接呼び出すことができません。その代わり、クラウドファイルプレースホルダーをデハイドレートする唯一のサポートされた方法は、ファイルのピン留め属性をクリアし、ピン留め解除属性を設定することです。実際のデハイドレートは、これら 2 つの属性に関するディレクトリ変更通知を同期エンジンが受け取った後に非同期で実行されます。このフラグを指定すると、プラットフォームは任意の同期済みクラウドファイルプレースホルダーに対して CfDehydratePlaceholder を直接呼び出せるようになります。同期プロバイダーは自動デハイドレートをサポートすることが推奨されます。
ALLOW_FULL_RESTART_HYDRATION このポリシー修飾子は、AV フィルターによるファイルのスキャン試行をプラットフォームが捕捉した際に、そのファイルを同期的に完全ハイドレートすることを許可します。FetchData コールバックから RestartHydration を使用して fileSize を変更したい同期プロバイダーは、ALLOW_FULL_RESTART_HYDRATION ポリシーをオプトインする必要があります。これは、ファイルをスキャンしようとするウイルス対策・マルウェア対策ソフトウェアと、RestartHydration を使用して fileSize を変更しようとするプロバイダーとの間で発生し得るデッドロックを回避するためです。

メモ: この修飾子は、CfGetPlatformInfo から取得した PlatformVersion.IntegrationNumber0x500 以上の場合にのみサポートされます。
PopulationCF_POPULATION_POLICY4+8+8

ポピュレーションポリシーを使用すると、同期プロバイダーは、プレースホルダーの名前空間 (ディレクトリとファイルの両方) をプラットフォームがどのように作成するかを制御できます。現在、修飾子は定義されておらず、次の 3 つのプライマリポリシーがあります。

ポリシー 説明
ALWAYS_FULL ALWAYS_FULL を選択すると、プラットフォームは完全な名前空間が常にローカルで利用可能であると想定します。ディレクトリ列挙要求が同期プロバイダーに転送されることはありません。
FULL FULL ポピュレーションポリシーでは、エントリが完全に取得されていないディレクトリへのアクセスをプラットフォームが検出すると、ユーザー要求を完了する前に、そのディレクトリ配下のすべてのエントリを返すよう同期プロバイダーに要求します。
PARTIAL PARTIAL ポピュレーションポリシーでは、エントリが完全に取得されていないディレクトリへのアクセスをプラットフォームが検出すると、ユーザーアプリケーションが必要とするエントリのみを同期プロバイダーに要求します。
InSyncCF_INSYNC_POLICY4+12+12InSync ポリシーを使用すると、同期プロバイダーは、プレースホルダーの同期済み (in-sync) 状態をプラットフォームがいつクリアするかを制御できます。データが変更された場合に常に同期済み状態をクリアすることに加えて、プラットフォームは現在、3 つのファイル属性 (ReadOnlySystemHidden) と 2 つのファイル時刻 (CreateTimeLastWriteTime) の任意の組み合わせが変更された場合に同期済み状態をクリアできます。これらのポリシーは、ファイルとディレクトリに個別に適用できます。
HardLinkCF_HARDLINK_POLICY4+16+16既定では、プラットフォームはいずれのプレースホルダーに対してもハードリンクの作成を許可しません。ただし、ハードリンクを処理できる同期プロバイダーは、ALLOWED ポリシーを使用してサポートを有効にするようプラットフォームに指示できます。このポリシーでは、リンクが同じ同期ルート配下にあるか、どの同期ルートにも属さない限り、アプリケーションはファイルシステムがサポートする数だけハードリンクを作成できます。プラットフォームは、同期ルート外の最初のリンクが作成された時点でプレースホルダーを強制的にハイドレートし、同期ルート内の最後のリンクが削除された時点でプレースホルダーを通常のファイルに戻します。ポリシーと互換性のないハードリンクの作成は、HRESULT ERROR_CLOUD_FILES_INCOMPATIBLE_HARDLINKS で失敗します。ポリシーと互換性のないプレースホルダー操作も ERROR_CLOUD_FILES_INCOMPATIBLE_HARDLINKS で失敗します。
PlaceholderManagementCF_PLACEHOLDER_MANAGEMENT_POLICY4+20+20

既定では、同期ルート内でプレースホルダー管理操作を実行できるのは同期プロバイダーだけです。同期プロバイダー以外のプロセスは、同期ルートが非アクティブな場合 (すなわち、その同期ルートに接続している同期プロバイダーが存在しない場合) にのみプレースホルダー管理操作を実行できます。これらのポリシーを有効にすると、同期プロバイダー以外のプロセスも、アクティブな同期ルート内でそれぞれのプレースホルダー管理操作を実行できるようになります。既定のポリシーは CF_PLACEHOLDER_MANAGEMENT_POLICY_DEFAULT で、接続済みの同期プロバイダーのみがプレースホルダー管理操作を実行できます。以下の 3 つのポリシーは任意に組み合わせて指定できます。

ポリシー 説明
CF_PLACEHOLDER_MANAGEMENT_POLICY_CREATE_UNRESTRICTED 登録時にこのポリシーを指定すると、任意のプロセスが CfCreatePlaceholders を呼び出して、アクティブな同期ルート内にプレースホルダーを作成できます。
CF_PLACEHOLDER_MANAGEMENT_POLICY_CONVERT_UNRESTRICTED 登録時にこのポリシーを指定すると、任意のプロセスが CfConvertToPlaceholder を呼び出して、アクティブな同期ルート内のファイルまたはディレクトリをプレースホルダーに変換できます。
CF_PLACEHOLDER_MANAGEMENT_POLICY_UPDATE_UNRESTRICTED 登録時にこのポリシーを指定すると、任意のプロセスが API CfUpdatePlaceholder を介して、アクティブな同期ルート内のプレースホルダーを更新できます。
メモ

これらのフラグは、CfGetPlatformInfo から取得した PlatformVersion.IntegrationNumber0x310 以上の場合にのみサポートされます。

公式ドキュメント

同期ルートが使用する同期ポリシーを定義します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での定義

#include <windows.h>

// CF_HYDRATION_POLICY  (x64 4 / x86 4 バイト)
typedef struct CF_HYDRATION_POLICY {
    CF_HYDRATION_POLICY_PRIMARY Primary;
    CF_HYDRATION_POLICY_MODIFIER Modifier;
} CF_HYDRATION_POLICY;

// CF_POPULATION_POLICY  (x64 4 / x86 4 バイト)
typedef struct CF_POPULATION_POLICY {
    CF_POPULATION_POLICY_PRIMARY Primary;
    CF_POPULATION_POLICY_MODIFIER Modifier;
} CF_POPULATION_POLICY;

// CF_SYNC_POLICIES  (x64 24 / x86 24 バイト)
typedef struct CF_SYNC_POLICIES {
    DWORD StructSize;
    CF_HYDRATION_POLICY Hydration;
    CF_POPULATION_POLICY Population;
    CF_INSYNC_POLICY InSync;
    CF_HARDLINK_POLICY HardLink;
    CF_PLACEHOLDER_MANAGEMENT_POLICY PlaceholderManagement;
} CF_SYNC_POLICIES;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct CF_HYDRATION_POLICY
{
    public ushort Primary;
    public ushort Modifier;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct CF_POPULATION_POLICY
{
    public ushort Primary;
    public ushort Modifier;
}

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct CF_SYNC_POLICIES
{
    public uint StructSize;
    public CF_HYDRATION_POLICY Hydration;
    public CF_POPULATION_POLICY Population;
    public uint InSync;
    public int HardLink;
    public int PlaceholderManagement;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure CF_HYDRATION_POLICY
    Public Primary As UShort
    Public Modifier As UShort
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure CF_POPULATION_POLICY
    Public Primary As UShort
    Public Modifier As UShort
End Structure

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure CF_SYNC_POLICIES
    Public StructSize As UInteger
    Public Hydration As CF_HYDRATION_POLICY
    Public Population As CF_POPULATION_POLICY
    Public InSync As UInteger
    Public HardLink As Integer
    Public PlaceholderManagement As Integer
End Structure
import ctypes
from ctypes import wintypes

class CF_HYDRATION_POLICY(ctypes.Structure):
    _fields_ = [
        ("Primary", ctypes.c_ushort),
        ("Modifier", ctypes.c_ushort),
    ]

class CF_POPULATION_POLICY(ctypes.Structure):
    _fields_ = [
        ("Primary", ctypes.c_ushort),
        ("Modifier", ctypes.c_ushort),
    ]

class CF_SYNC_POLICIES(ctypes.Structure):
    _fields_ = [
        ("StructSize", wintypes.DWORD),
        ("Hydration", CF_HYDRATION_POLICY),
        ("Population", CF_POPULATION_POLICY),
        ("InSync", wintypes.DWORD),
        ("HardLink", ctypes.c_int),
        ("PlaceholderManagement", ctypes.c_int),
    ]
#[repr(C)]
pub struct CF_HYDRATION_POLICY {
    pub Primary: u16,
    pub Modifier: u16,
}

#[repr(C)]
pub struct CF_POPULATION_POLICY {
    pub Primary: u16,
    pub Modifier: u16,
}

#[repr(C)]
pub struct CF_SYNC_POLICIES {
    pub StructSize: u32,
    pub Hydration: CF_HYDRATION_POLICY,
    pub Population: CF_POPULATION_POLICY,
    pub InSync: u32,
    pub HardLink: i32,
    pub PlaceholderManagement: i32,
}
import "golang.org/x/sys/windows"

type CF_HYDRATION_POLICY struct {
	Primary uint16
	Modifier uint16
}

type CF_POPULATION_POLICY struct {
	Primary uint16
	Modifier uint16
}

type CF_SYNC_POLICIES struct {
	StructSize uint32
	Hydration CF_HYDRATION_POLICY
	Population CF_POPULATION_POLICY
	InSync uint32
	HardLink int32
	PlaceholderManagement int32
}
type
  CF_HYDRATION_POLICY = record
    Primary: Word;
    Modifier: Word;
  end;

  CF_POPULATION_POLICY = record
    Primary: Word;
    Modifier: Word;
  end;

  CF_SYNC_POLICIES = record
    StructSize: DWORD;
    Hydration: CF_HYDRATION_POLICY;
    Population: CF_POPULATION_POLICY;
    InSync: DWORD;
    HardLink: Integer;
    PlaceholderManagement: Integer;
  end;
const CF_HYDRATION_POLICY = extern struct {
    Primary: u16,
    Modifier: u16,
};

const CF_POPULATION_POLICY = extern struct {
    Primary: u16,
    Modifier: u16,
};

const CF_SYNC_POLICIES = extern struct {
    StructSize: u32,
    Hydration: CF_HYDRATION_POLICY,
    Population: CF_POPULATION_POLICY,
    InSync: u32,
    HardLink: i32,
    PlaceholderManagement: i32,
};
type
  CF_HYDRATION_POLICY {.bycopy.} = object
    Primary: uint16
    Modifier: uint16

  CF_POPULATION_POLICY {.bycopy.} = object
    Primary: uint16
    Modifier: uint16

  CF_SYNC_POLICIES {.bycopy.} = object
    StructSize: uint32
    Hydration: CF_HYDRATION_POLICY
    Population: CF_POPULATION_POLICY
    InSync: uint32
    HardLink: int32
    PlaceholderManagement: int32
struct CF_HYDRATION_POLICY
{
    ushort Primary;
    ushort Modifier;
}

struct CF_POPULATION_POLICY
{
    ushort Primary;
    ushort Modifier;
}

struct CF_SYNC_POLICIES
{
    uint StructSize;
    CF_HYDRATION_POLICY Hydration;
    CF_POPULATION_POLICY Population;
    uint InSync;
    int HardLink;
    int PlaceholderManagement;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; CF_SYNC_POLICIES サイズ: 24 バイト(x64)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; StructSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; Hydration : CF_HYDRATION_POLICY (+4, 4byte)  varptr(st)+4 を基点に操作(4byte:入れ子/配列)
; Population : CF_POPULATION_POLICY (+8, 4byte)  varptr(st)+8 を基点に操作(4byte:入れ子/配列)
; InSync : CF_INSYNC_POLICY (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; HardLink : CF_HARDLINK_POLICY (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; PlaceholderManagement : CF_PLACEHOLDER_MANAGEMENT_POLICY (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
; ※GUID・入れ子構造体はデフォルト型でないため、依存する #defstruct を先に定義(下記に同梱)。
#defstruct global CF_HYDRATION_POLICY
    #field short Primary
    #field short Modifier
#endstruct

#defstruct global CF_POPULATION_POLICY
    #field short Primary
    #field short Modifier
#endstruct

#defstruct global CF_SYNC_POLICIES
    #field int StructSize
    #field CF_HYDRATION_POLICY Hydration
    #field CF_POPULATION_POLICY Population
    #field int InSync
    #field int HardLink
    #field int PlaceholderManagement
#endstruct

stdim st, CF_SYNC_POLICIES        ; NSTRUCT 変数を確保
st->StructSize = 100
mes "StructSize=" + st->StructSize