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

CfRegisterSyncRoot

関数
指定パスを同期ルートとして登録する。
DLLcldapi.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

// cldapi.dll
#include <windows.h>

HRESULT CfRegisterSyncRoot(
    LPCWSTR SyncRootPath,
    const CF_SYNC_REGISTRATION* Registration,
    const CF_SYNC_POLICIES* Policies,
    CF_REGISTER_FLAGS RegisterFlags
);

パラメーター

名前型方向説明
SyncRootPathLPCWSTRin登録する同期ルートへのパス。
RegistrationCF_SYNC_REGISTRATION*in

登録する同期プロバイダーと同期ルートに関する情報を格納します。

ProviderName と ProviderVersion はエンド ユーザーに表示される文字列で、それぞれ最大長は 255 文字です。

SyncRootIdentity と FileIdentity はどちらも省略可能で、指定しない場合は対応するバッファーの長さも 0 に設定する必要があります。これらは、同期プロバイダーが任意のデータを同期ルートに永続的に関連付けるための手段です。

プラットフォームは、同期プロバイダーへのコールバックにおいて SyncRootIdentity を同期プロバイダーに返します。同期ルートの FileIdentity BLOB は、コールバックの対象が同期ルート自体である場合にのみ提供されます。

この機能は同期プロバイダーの利便性のためだけに用意されたものであり、どちらの BLOB も同期プロバイダーの外部では特別な意味を持ちません。

FileIdentity の最大許容長は 4KB、SyncRootIdentity の最大許容長は 64KB です。いずれかの最大長を超えると、この API は ERROR_INVALID_PARAMETER で失敗します。

ProviderId は特定の同期プロバイダーを識別するための GUID です。これは省略可能です。指定しない場合、プラットフォームは ProviderName 文字列の MD5 ハッシュを使用して GUID を生成します。この情報はテレメトリにのみ使用され、同期プロバイダーが異なる ProviderName 文字列で同期ルートを登録した場合でも、プラットフォームが同一の同期プロバイダーによるアクティビティをより効率的かつ正確に関連付けられるようにします。同期プロバイダーは、その同期製品のすべてのバージョンで常に同じ GUID を指定することが推奨されます。ただし、最良のユーザー エクスペリエンスのために、同期プロバイダーが異なる ProviderName 文字列を選択することは自由です。

PoliciesCF_SYNC_POLICIES*in登録する同期ルートのポリシー。
RegisterFlagsCF_REGISTER_FLAGSin

既存の同期ルートおよび新しい同期ルートを登録するためのフラグ。

フラグ 説明
CF_REGISTER_FLAG_UPDATE 同期プロバイダーは CF_REGISTER_FLAG_UPDATE を渡すことで、以前に登録した同期ルートの識別情報とポリシーを再登録できます。
CF_REGISTER_FLAG_DISABLE_ON_DEMAND_POPULATION_ON_ROOT オンデマンドのディレクトリ/フォルダーの populate 動作は、population ポリシーによって全体的に制御されます。このフラグを使用すると、同期プロバイダーは、同期ルート配下のその他すべてのディレクトリでオンデマンドの populate を有効なままにしつつ、同期ルート自体についてのみオンデマンドの populate 動作を無効にできます。これは、同期プロバイダーが同期ルート直下の子ファイル/ディレクトリを事前に populate したい場合に便利です。
CF_REGISTER_FLAG_MARK_IN_SYNC_ON_ROOT このフラグを使用すると、同期プロバイダーは、登録する同期ルートを登録時に同時に同期済み (in-sync) としてマークできます。別の方法として、後から同期ルートに対して CfSetInSyncState を呼び出すこともできます。

戻り値の型: HRESULT

公式ドキュメント

1 回限りの同期ルート登録を実行します。

戻り値

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラー コードを返します。

解説(Remarks)

これは、同期プロバイダーのインストール時、個々のユーザーに対する初回セットアップ時、またはユーザーが別の同期ルートを構成するとき (このシナリオがサポートされている場合) に使用できます。

メモ

2 つの同期ルート ツリーが重複することは許可されません。ディレクトリのハード リンクはファイル システムによって禁止されているため、2 つの同期ルートが重複し得る唯一のケースは、直接の先祖/子孫の関係にある場合です。プラットフォームは、特定のボリュームに登録されたすべての同期ルートを永続的に記憶し、重複する同期ルートを作成しようとする試みを失敗させる責任を負います。

同期プロバイダーは、登録する同期ルートに対して WRITE_DATA または WRITE_DAC のアクセス権を持っている必要があります。持っていない場合、登録は ERROR_CLOUD_FILE_ACCESS_DENIED で失敗します。

同期プロバイダーは、同期プロバイダー自体と登録する同期ルートのさまざまな識別情報、プラットフォームが同期ルートごとに動作を調整するために使用する一連のポリシー、および同期プロバイダーが登録操作をより細かく制御するための一連の登録フラグを含む登録レコードを指定する必要があります。

省略可能であると明示されていない限り、すべてのフィールドは必須であり、指定しない場合、API 呼び出しは無効なパラメーター エラーで失敗します。

将来の拡張が見込まれるすべての構造体は、StructSize フィールドで始まります。構造体のサイズを正確に設定する責任は呼び出し元にあります。

プラットフォームは現在、次の 5 種類の Policies をサポートしています。

Hydration ポリシー

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

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

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

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

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

修飾子 説明
VALIDATION_REQUIRED このポリシー修飾子は、同期プロバイダーに 2 つの保証を提供します。1 つ目は、同期プロバイダーが返したデータが、ユーザー アプリケーションに返される前に必ずディスクに永続化されることを保証します。2 つ目は、同期プロバイダーが以前にプラットフォームへ返したデータと同じデータを取得し、その整合性を検証できるようにします。同期プロバイダーによる整合性の確認が成功した場合にのみ、プラットフォームはユーザー IO 要求を完了します。この修飾子は、追加のディスク IO と引き換えに、エンド ツー エンドのデータ整合性の実現を支援します。
STREAMING_ALLOWED このポリシー修飾子は、同期プロバイダーが返したデータをローカル ディスクに保存しないことをプラットフォームに許可します。このポリシー修飾子は VALIDATION_REQUIRED と相互排他です。両方のフラグが指定された場合、この API は ERROR_INVALID_PARAMETER で失敗します。
AUTO_DEHYDRATION_ALLOWED このポリシー修飾子は、同期プロバイダーの助けを借りずに、同期済み (in-sync) のクラウド ファイル プレースホルダーをデハイドレートすることをプラットフォームに許可します。このフラグがない場合、プラットフォームは CfDehydratePlaceholder を直接呼び出すことはできません。その代わり、クラウド ファイル プレースホルダーをデハイドレートする唯一のサポートされた方法は、ファイルの pinned 属性をクリアして unpinned 属性を設定することであり、実際のデハイドレートは、同期エンジンがこれら 2 つの属性に関するディレクトリ変更通知を受け取った後に非同期で実行されます。このフラグが指定されている場合、プラットフォームは、同期済みの任意のクラウド ファイル プレースホルダーに対して CfDehydratePlaceholder を直接呼び出せるようになります。同期プロバイダーは自動デハイドレートをサポートすることが推奨されます。

Population ポリシー

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

ポリシー 説明
ALWAYS_FULL プラットフォームは、完全な名前空間が常にローカルで利用可能であると想定します。ディレクトリの列挙要求を同期プロバイダーに転送することはありません。
FULL 完全に populate されていないディレクトリへのアクセスを検出すると、プラットフォームは、ユーザー要求を完了する前に、そのディレクトリ配下のすべてのエントリを返すよう同期プロバイダーに要求します。
PARTIAL 完全に populate されていないディレクトリへのアクセスを検出すると、プラットフォームは、ユーザー アプリケーションが必要とするエントリのみを同期プロバイダーに要求します。

InSync 追跡ポリシー

InSync ポリシーを使用すると、同期プロバイダーは、プラットフォームがプレースホルダーの同期済み (in-sync) 状態をいつクリアするかを制御できます。データが変更された場合に常に in-sync をクリアすることに加えて、プラットフォームは現在、3 つのファイル属性 (ReadOnly、System、Hidden) と 2 つのファイル時刻 (CreateTime と LastWriteTime) の任意の組み合わせが変更されたときに in-sync をクリアできます。これらのポリシーは、ファイルとディレクトリに個別に適用できます。

ハードリンク ポリシー

既定では、プラットフォームはどのプレースホルダーに対してもハード リンクの作成を許可しません。ただし、ハード リンクを処理できる同期プロバイダーは、ALLOWED ポリシーによってこのサポートを有効にするようプラットフォームに指示できます。このポリシーを使用すると、リンクが同じ同期ルートの配下にあるか、いずれの同期ルートにも属していない限り、アプリケーションはファイル システムがサポートする数だけハード リンクを作成できます。プラットフォームは、同期ルート外の最初のリンクが作成された時点でプレースホルダーを強制的にハイドレートし、同期ルート内の最後のリンクが削除された時点でプレースホルダーを通常のファイルに戻します。ポリシーと互換性のないハード リンクの作成は STATUS_CLOUD_FILES_INCOMPATIBLE_HARDLINKS で失敗します。ポリシーと互換性のないプレースホルダー操作も STATUS_CLOUD_FILES_INCOMPATIBLE_HARDLINKS で失敗します。

プレースホルダー管理ポリシー

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

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

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

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

各言語での呼び出し定義

// cldapi.dll
#include <windows.h>

HRESULT CfRegisterSyncRoot(
    LPCWSTR SyncRootPath,
    const CF_SYNC_REGISTRATION* Registration,
    const CF_SYNC_POLICIES* Policies,
    CF_REGISTER_FLAGS RegisterFlags
);
[DllImport("cldapi.dll", ExactSpelling = true)]
static extern int CfRegisterSyncRoot(
    [MarshalAs(UnmanagedType.LPWStr)] string SyncRootPath,   // LPCWSTR
    IntPtr Registration,   // CF_SYNC_REGISTRATION*
    IntPtr Policies,   // CF_SYNC_POLICIES*
    int RegisterFlags   // CF_REGISTER_FLAGS
);
<DllImport("cldapi.dll", ExactSpelling:=True)>
Public Shared Function CfRegisterSyncRoot(
    <MarshalAs(UnmanagedType.LPWStr)> SyncRootPath As String,   ' LPCWSTR
    Registration As IntPtr,   ' CF_SYNC_REGISTRATION*
    Policies As IntPtr,   ' CF_SYNC_POLICIES*
    RegisterFlags As Integer   ' CF_REGISTER_FLAGS
) As Integer
End Function
' SyncRootPath : LPCWSTR
' Registration : CF_SYNC_REGISTRATION*
' Policies : CF_SYNC_POLICIES*
' RegisterFlags : CF_REGISTER_FLAGS
Declare PtrSafe Function CfRegisterSyncRoot Lib "cldapi" ( _
    ByVal SyncRootPath As LongPtr, _
    ByVal Registration As LongPtr, _
    ByVal Policies As LongPtr, _
    ByVal RegisterFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CfRegisterSyncRoot = ctypes.windll.cldapi.CfRegisterSyncRoot
CfRegisterSyncRoot.restype = ctypes.c_int
CfRegisterSyncRoot.argtypes = [
    wintypes.LPCWSTR,  # SyncRootPath : LPCWSTR
    ctypes.c_void_p,  # Registration : CF_SYNC_REGISTRATION*
    ctypes.c_void_p,  # Policies : CF_SYNC_POLICIES*
    ctypes.c_int,  # RegisterFlags : CF_REGISTER_FLAGS
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('cldapi.dll')
CfRegisterSyncRoot = Fiddle::Function.new(
  lib['CfRegisterSyncRoot'],
  [
    Fiddle::TYPE_VOIDP,  # SyncRootPath : LPCWSTR
    Fiddle::TYPE_VOIDP,  # Registration : CF_SYNC_REGISTRATION*
    Fiddle::TYPE_VOIDP,  # Policies : CF_SYNC_POLICIES*
    Fiddle::TYPE_INT,  # RegisterFlags : CF_REGISTER_FLAGS
  ],
  Fiddle::TYPE_INT)
#[link(name = "cldapi")]
extern "system" {
    fn CfRegisterSyncRoot(
        SyncRootPath: *const u16,  // LPCWSTR
        Registration: *const CF_SYNC_REGISTRATION,  // CF_SYNC_REGISTRATION*
        Policies: *const CF_SYNC_POLICIES,  // CF_SYNC_POLICIES*
        RegisterFlags: i32  // CF_REGISTER_FLAGS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("cldapi.dll")]
public static extern int CfRegisterSyncRoot([MarshalAs(UnmanagedType.LPWStr)] string SyncRootPath, IntPtr Registration, IntPtr Policies, int RegisterFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'cldapi_CfRegisterSyncRoot' -Namespace Win32 -PassThru
# $api::CfRegisterSyncRoot(SyncRootPath, Registration, Policies, RegisterFlags)
#uselib "cldapi.dll"
#func global CfRegisterSyncRoot "CfRegisterSyncRoot" sptr, sptr, sptr, sptr
; CfRegisterSyncRoot SyncRootPath, varptr(Registration), varptr(Policies), RegisterFlags   ; 戻り値は stat
; SyncRootPath : LPCWSTR -> "sptr"
; Registration : CF_SYNC_REGISTRATION* -> "sptr"
; Policies : CF_SYNC_POLICIES* -> "sptr"
; RegisterFlags : CF_REGISTER_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "cldapi.dll"
#cfunc global CfRegisterSyncRoot "CfRegisterSyncRoot" wstr, var, var, int
; res = CfRegisterSyncRoot(SyncRootPath, Registration, Policies, RegisterFlags)
; SyncRootPath : LPCWSTR -> "wstr"
; Registration : CF_SYNC_REGISTRATION* -> "var"
; Policies : CF_SYNC_POLICIES* -> "var"
; RegisterFlags : CF_REGISTER_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT CfRegisterSyncRoot(LPCWSTR SyncRootPath, CF_SYNC_REGISTRATION* Registration, CF_SYNC_POLICIES* Policies, CF_REGISTER_FLAGS RegisterFlags)
#uselib "cldapi.dll"
#cfunc global CfRegisterSyncRoot "CfRegisterSyncRoot" wstr, var, var, int
; res = CfRegisterSyncRoot(SyncRootPath, Registration, Policies, RegisterFlags)
; SyncRootPath : LPCWSTR -> "wstr"
; Registration : CF_SYNC_REGISTRATION* -> "var"
; Policies : CF_SYNC_POLICIES* -> "var"
; RegisterFlags : CF_REGISTER_FLAGS -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	cldapi = windows.NewLazySystemDLL("cldapi.dll")
	procCfRegisterSyncRoot = cldapi.NewProc("CfRegisterSyncRoot")
)

// SyncRootPath (LPCWSTR), Registration (CF_SYNC_REGISTRATION*), Policies (CF_SYNC_POLICIES*), RegisterFlags (CF_REGISTER_FLAGS)
r1, _, err := procCfRegisterSyncRoot.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(SyncRootPath))),
	uintptr(Registration),
	uintptr(Policies),
	uintptr(RegisterFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function CfRegisterSyncRoot(
  SyncRootPath: PWideChar;   // LPCWSTR
  Registration: Pointer;   // CF_SYNC_REGISTRATION*
  Policies: Pointer;   // CF_SYNC_POLICIES*
  RegisterFlags: Integer   // CF_REGISTER_FLAGS
): Integer; stdcall;
  external 'cldapi.dll' name 'CfRegisterSyncRoot';
result := DllCall("cldapi\CfRegisterSyncRoot"
    , "WStr", SyncRootPath   ; LPCWSTR
    , "Ptr", Registration   ; CF_SYNC_REGISTRATION*
    , "Ptr", Policies   ; CF_SYNC_POLICIES*
    , "Int", RegisterFlags   ; CF_REGISTER_FLAGS
    , "Int")   ; return: HRESULT
●CfRegisterSyncRoot(SyncRootPath, Registration, Policies, RegisterFlags) = DLL("cldapi.dll", "int CfRegisterSyncRoot(char*, void*, void*, int)")
# 呼び出し: CfRegisterSyncRoot(SyncRootPath, Registration, Policies, RegisterFlags)
# SyncRootPath : LPCWSTR -> "char*"
# Registration : CF_SYNC_REGISTRATION* -> "void*"
# Policies : CF_SYNC_POLICIES* -> "void*"
# RegisterFlags : CF_REGISTER_FLAGS -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "cldapi" fn CfRegisterSyncRoot(
    SyncRootPath: [*c]const u16, // LPCWSTR
    Registration: [*c]CF_SYNC_REGISTRATION, // CF_SYNC_REGISTRATION*
    Policies: [*c]CF_SYNC_POLICIES, // CF_SYNC_POLICIES*
    RegisterFlags: i32 // CF_REGISTER_FLAGS
) callconv(std.os.windows.WINAPI) i32;
proc CfRegisterSyncRoot(
    SyncRootPath: WideCString,  # LPCWSTR
    Registration: ptr CF_SYNC_REGISTRATION,  # CF_SYNC_REGISTRATION*
    Policies: ptr CF_SYNC_POLICIES,  # CF_SYNC_POLICIES*
    RegisterFlags: int32  # CF_REGISTER_FLAGS
): int32 {.importc: "CfRegisterSyncRoot", stdcall, dynlib: "cldapi.dll".}
pragma(lib, "cldapi");
extern(Windows)
int CfRegisterSyncRoot(
    const(wchar)* SyncRootPath,   // LPCWSTR
    CF_SYNC_REGISTRATION* Registration,   // CF_SYNC_REGISTRATION*
    CF_SYNC_POLICIES* Policies,   // CF_SYNC_POLICIES*
    int RegisterFlags   // CF_REGISTER_FLAGS
);
ccall((:CfRegisterSyncRoot, "cldapi.dll"), stdcall, Int32,
      (Cwstring, Ptr{CF_SYNC_REGISTRATION}, Ptr{CF_SYNC_POLICIES}, Int32),
      SyncRootPath, Registration, Policies, RegisterFlags)
# SyncRootPath : LPCWSTR -> Cwstring
# Registration : CF_SYNC_REGISTRATION* -> Ptr{CF_SYNC_REGISTRATION}
# Policies : CF_SYNC_POLICIES* -> Ptr{CF_SYNC_POLICIES}
# RegisterFlags : CF_REGISTER_FLAGS -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CfRegisterSyncRoot(
    const uint16_t* SyncRootPath,
    void* Registration,
    void* Policies,
    int32_t RegisterFlags);
]]
local cldapi = ffi.load("cldapi")
-- cldapi.CfRegisterSyncRoot(SyncRootPath, Registration, Policies, RegisterFlags)
-- SyncRootPath : LPCWSTR
-- Registration : CF_SYNC_REGISTRATION*
-- Policies : CF_SYNC_POLICIES*
-- RegisterFlags : CF_REGISTER_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('cldapi.dll');
const CfRegisterSyncRoot = lib.func('__stdcall', 'CfRegisterSyncRoot', 'int32_t', ['str16', 'void *', 'void *', 'int32_t']);
// CfRegisterSyncRoot(SyncRootPath, Registration, Policies, RegisterFlags)
// SyncRootPath : LPCWSTR -> 'str16'
// Registration : CF_SYNC_REGISTRATION* -> 'void *'
// Policies : CF_SYNC_POLICIES* -> 'void *'
// RegisterFlags : CF_REGISTER_FLAGS -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("cldapi.dll", {
  CfRegisterSyncRoot: { parameters: ["buffer", "pointer", "pointer", "i32"], result: "i32" },
});
// lib.symbols.CfRegisterSyncRoot(SyncRootPath, Registration, Policies, RegisterFlags)
// SyncRootPath : LPCWSTR -> "buffer"
// Registration : CF_SYNC_REGISTRATION* -> "pointer"
// Policies : CF_SYNC_POLICIES* -> "pointer"
// RegisterFlags : CF_REGISTER_FLAGS -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CfRegisterSyncRoot(
    const uint16_t* SyncRootPath,
    void* Registration,
    void* Policies,
    int32_t RegisterFlags);
C, "cldapi.dll");
// $ffi->CfRegisterSyncRoot(SyncRootPath, Registration, Policies, RegisterFlags);
// SyncRootPath : LPCWSTR
// Registration : CF_SYNC_REGISTRATION*
// Policies : CF_SYNC_POLICIES*
// RegisterFlags : CF_REGISTER_FLAGS
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Cldapi extends StdCallLibrary {
    Cldapi INSTANCE = Native.load("cldapi", Cldapi.class);
    int CfRegisterSyncRoot(
        WString SyncRootPath,   // LPCWSTR
        Pointer Registration,   // CF_SYNC_REGISTRATION*
        Pointer Policies,   // CF_SYNC_POLICIES*
        int RegisterFlags   // CF_REGISTER_FLAGS
    );
}
@[Link("cldapi")]
lib Libcldapi
  fun CfRegisterSyncRoot = CfRegisterSyncRoot(
    SyncRootPath : UInt16*,   # LPCWSTR
    Registration : CF_SYNC_REGISTRATION*,   # CF_SYNC_REGISTRATION*
    Policies : CF_SYNC_POLICIES*,   # CF_SYNC_POLICIES*
    RegisterFlags : Int32   # CF_REGISTER_FLAGS
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CfRegisterSyncRootNative = Int32 Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>, Int32);
typedef CfRegisterSyncRootDart = int Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>, int);
final CfRegisterSyncRoot = DynamicLibrary.open('cldapi.dll')
    .lookupFunction<CfRegisterSyncRootNative, CfRegisterSyncRootDart>('CfRegisterSyncRoot');
// SyncRootPath : LPCWSTR -> Pointer<Utf16>
// Registration : CF_SYNC_REGISTRATION* -> Pointer<Void>
// Policies : CF_SYNC_POLICIES* -> Pointer<Void>
// RegisterFlags : CF_REGISTER_FLAGS -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CfRegisterSyncRoot(
  SyncRootPath: PWideChar;   // LPCWSTR
  Registration: Pointer;   // CF_SYNC_REGISTRATION*
  Policies: Pointer;   // CF_SYNC_POLICIES*
  RegisterFlags: Integer   // CF_REGISTER_FLAGS
): Integer; stdcall;
  external 'cldapi.dll' name 'CfRegisterSyncRoot';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CfRegisterSyncRoot"
  c_CfRegisterSyncRoot :: CWString -> Ptr () -> Ptr () -> Int32 -> IO Int32
-- SyncRootPath : LPCWSTR -> CWString
-- Registration : CF_SYNC_REGISTRATION* -> Ptr ()
-- Policies : CF_SYNC_POLICIES* -> Ptr ()
-- RegisterFlags : CF_REGISTER_FLAGS -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cfregistersyncroot =
  foreign "CfRegisterSyncRoot"
    ((ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> int32_t @-> returning int32_t)
(* SyncRootPath : LPCWSTR -> (ptr uint16_t) *)
(* Registration : CF_SYNC_REGISTRATION* -> (ptr void) *)
(* Policies : CF_SYNC_POLICIES* -> (ptr void) *)
(* RegisterFlags : CF_REGISTER_FLAGS -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library cldapi (t "cldapi.dll"))
(cffi:use-foreign-library cldapi)

(cffi:defcfun ("CfRegisterSyncRoot" cf-register-sync-root :convention :stdcall) :int32
  (sync-root-path (:string :encoding :utf-16le))   ; LPCWSTR
  (registration :pointer)   ; CF_SYNC_REGISTRATION*
  (policies :pointer)   ; CF_SYNC_POLICIES*
  (register-flags :int32))   ; CF_REGISTER_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CfRegisterSyncRoot = Win32::API::More->new('cldapi',
    'int CfRegisterSyncRoot(LPCWSTR SyncRootPath, LPVOID Registration, LPVOID Policies, int RegisterFlags)');
# my $ret = $CfRegisterSyncRoot->Call($SyncRootPath, $Registration, $Policies, $RegisterFlags);
# SyncRootPath : LPCWSTR -> LPCWSTR
# Registration : CF_SYNC_REGISTRATION* -> LPVOID
# Policies : CF_SYNC_POLICIES* -> LPVOID
# RegisterFlags : CF_REGISTER_FLAGS -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型