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プロバイダー名やID等の登録情報を保持するCF_SYNC_REGISTRATION構造体へのポインタ。
PoliciesCF_SYNC_POLICIES*inハイドレーション等の同期ポリシーを定義するCF_SYNC_POLICIES構造体へのポインタ。
RegisterFlagsCF_REGISTER_FLAGSin登録動作を制御するCF_REGISTER_FLAGSフラグ。既存ルートの更新等を指定する。

戻り値の型: HRESULT

各言語での呼び出し定義

// 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 を使用。

関連項目

使用する型