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

CfSetInSyncState

関数
プレースホルダーの同期済み状態を設定する。
DLLcldapi.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

HRESULT CfSetInSyncState(
    HANDLE FileHandle,
    CF_IN_SYNC_STATE InSyncState,
    CF_SET_IN_SYNC_FLAGS InSyncFlags,
    LONGLONG* InSyncUsn   // optional
);

パラメーター

名前方向説明
FileHandleHANDLEin同期状態を設定する対象ファイルまたはディレクトリのハンドル。
InSyncStateCF_IN_SYNC_STATEin設定する同期済み状態を示すCF_IN_SYNC_STATE列挙値。
InSyncFlagsCF_SET_IN_SYNC_FLAGSin状態設定動作を制御するCF_SET_IN_SYNC_FLAGSフラグ。
InSyncUsnLONGLONG*inoutoptional設定時のUSN値を受け取るLONGLONGへのポインタ。入出力用で競合検出に使う。NULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT CfSetInSyncState(
    HANDLE FileHandle,
    CF_IN_SYNC_STATE InSyncState,
    CF_SET_IN_SYNC_FLAGS InSyncFlags,
    LONGLONG* InSyncUsn   // optional
);
[DllImport("cldapi.dll", ExactSpelling = true)]
static extern int CfSetInSyncState(
    IntPtr FileHandle,   // HANDLE
    int InSyncState,   // CF_IN_SYNC_STATE
    int InSyncFlags,   // CF_SET_IN_SYNC_FLAGS
    IntPtr InSyncUsn   // LONGLONG* optional, in/out
);
<DllImport("cldapi.dll", ExactSpelling:=True)>
Public Shared Function CfSetInSyncState(
    FileHandle As IntPtr,   ' HANDLE
    InSyncState As Integer,   ' CF_IN_SYNC_STATE
    InSyncFlags As Integer,   ' CF_SET_IN_SYNC_FLAGS
    InSyncUsn As IntPtr   ' LONGLONG* optional, in/out
) As Integer
End Function
' FileHandle : HANDLE
' InSyncState : CF_IN_SYNC_STATE
' InSyncFlags : CF_SET_IN_SYNC_FLAGS
' InSyncUsn : LONGLONG* optional, in/out
Declare PtrSafe Function CfSetInSyncState Lib "cldapi" ( _
    ByVal FileHandle As LongPtr, _
    ByVal InSyncState As Long, _
    ByVal InSyncFlags As Long, _
    ByVal InSyncUsn As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CfSetInSyncState = ctypes.windll.cldapi.CfSetInSyncState
CfSetInSyncState.restype = ctypes.c_int
CfSetInSyncState.argtypes = [
    wintypes.HANDLE,  # FileHandle : HANDLE
    ctypes.c_int,  # InSyncState : CF_IN_SYNC_STATE
    ctypes.c_int,  # InSyncFlags : CF_SET_IN_SYNC_FLAGS
    ctypes.POINTER(ctypes.c_longlong),  # InSyncUsn : LONGLONG* optional, in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('cldapi.dll')
CfSetInSyncState = Fiddle::Function.new(
  lib['CfSetInSyncState'],
  [
    Fiddle::TYPE_VOIDP,  # FileHandle : HANDLE
    Fiddle::TYPE_INT,  # InSyncState : CF_IN_SYNC_STATE
    Fiddle::TYPE_INT,  # InSyncFlags : CF_SET_IN_SYNC_FLAGS
    Fiddle::TYPE_VOIDP,  # InSyncUsn : LONGLONG* optional, in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "cldapi")]
extern "system" {
    fn CfSetInSyncState(
        FileHandle: *mut core::ffi::c_void,  // HANDLE
        InSyncState: i32,  // CF_IN_SYNC_STATE
        InSyncFlags: i32,  // CF_SET_IN_SYNC_FLAGS
        InSyncUsn: *mut i64  // LONGLONG* optional, in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("cldapi.dll")]
public static extern int CfSetInSyncState(IntPtr FileHandle, int InSyncState, int InSyncFlags, IntPtr InSyncUsn);
"@
$api = Add-Type -MemberDefinition $sig -Name 'cldapi_CfSetInSyncState' -Namespace Win32 -PassThru
# $api::CfSetInSyncState(FileHandle, InSyncState, InSyncFlags, InSyncUsn)
#uselib "cldapi.dll"
#func global CfSetInSyncState "CfSetInSyncState" sptr, sptr, sptr, sptr
; CfSetInSyncState FileHandle, InSyncState, InSyncFlags, varptr(InSyncUsn)   ; 戻り値は stat
; FileHandle : HANDLE -> "sptr"
; InSyncState : CF_IN_SYNC_STATE -> "sptr"
; InSyncFlags : CF_SET_IN_SYNC_FLAGS -> "sptr"
; InSyncUsn : LONGLONG* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "cldapi.dll"
#cfunc global CfSetInSyncState "CfSetInSyncState" sptr, int, int, var
; res = CfSetInSyncState(FileHandle, InSyncState, InSyncFlags, InSyncUsn)
; FileHandle : HANDLE -> "sptr"
; InSyncState : CF_IN_SYNC_STATE -> "int"
; InSyncFlags : CF_SET_IN_SYNC_FLAGS -> "int"
; InSyncUsn : LONGLONG* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT CfSetInSyncState(HANDLE FileHandle, CF_IN_SYNC_STATE InSyncState, CF_SET_IN_SYNC_FLAGS InSyncFlags, LONGLONG* InSyncUsn)
#uselib "cldapi.dll"
#cfunc global CfSetInSyncState "CfSetInSyncState" intptr, int, int, var
; res = CfSetInSyncState(FileHandle, InSyncState, InSyncFlags, InSyncUsn)
; FileHandle : HANDLE -> "intptr"
; InSyncState : CF_IN_SYNC_STATE -> "int"
; InSyncFlags : CF_SET_IN_SYNC_FLAGS -> "int"
; InSyncUsn : LONGLONG* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	cldapi = windows.NewLazySystemDLL("cldapi.dll")
	procCfSetInSyncState = cldapi.NewProc("CfSetInSyncState")
)

// FileHandle (HANDLE), InSyncState (CF_IN_SYNC_STATE), InSyncFlags (CF_SET_IN_SYNC_FLAGS), InSyncUsn (LONGLONG* optional, in/out)
r1, _, err := procCfSetInSyncState.Call(
	uintptr(FileHandle),
	uintptr(InSyncState),
	uintptr(InSyncFlags),
	uintptr(InSyncUsn),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function CfSetInSyncState(
  FileHandle: THandle;   // HANDLE
  InSyncState: Integer;   // CF_IN_SYNC_STATE
  InSyncFlags: Integer;   // CF_SET_IN_SYNC_FLAGS
  InSyncUsn: Pointer   // LONGLONG* optional, in/out
): Integer; stdcall;
  external 'cldapi.dll' name 'CfSetInSyncState';
result := DllCall("cldapi\CfSetInSyncState"
    , "Ptr", FileHandle   ; HANDLE
    , "Int", InSyncState   ; CF_IN_SYNC_STATE
    , "Int", InSyncFlags   ; CF_SET_IN_SYNC_FLAGS
    , "Ptr", InSyncUsn   ; LONGLONG* optional, in/out
    , "Int")   ; return: HRESULT
●CfSetInSyncState(FileHandle, InSyncState, InSyncFlags, InSyncUsn) = DLL("cldapi.dll", "int CfSetInSyncState(void*, int, int, void*)")
# 呼び出し: CfSetInSyncState(FileHandle, InSyncState, InSyncFlags, InSyncUsn)
# FileHandle : HANDLE -> "void*"
# InSyncState : CF_IN_SYNC_STATE -> "int"
# InSyncFlags : CF_SET_IN_SYNC_FLAGS -> "int"
# InSyncUsn : LONGLONG* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "cldapi" fn CfSetInSyncState(
    FileHandle: ?*anyopaque, // HANDLE
    InSyncState: i32, // CF_IN_SYNC_STATE
    InSyncFlags: i32, // CF_SET_IN_SYNC_FLAGS
    InSyncUsn: [*c]i64 // LONGLONG* optional, in/out
) callconv(std.os.windows.WINAPI) i32;
proc CfSetInSyncState(
    FileHandle: pointer,  # HANDLE
    InSyncState: int32,  # CF_IN_SYNC_STATE
    InSyncFlags: int32,  # CF_SET_IN_SYNC_FLAGS
    InSyncUsn: ptr int64  # LONGLONG* optional, in/out
): int32 {.importc: "CfSetInSyncState", stdcall, dynlib: "cldapi.dll".}
pragma(lib, "cldapi");
extern(Windows)
int CfSetInSyncState(
    void* FileHandle,   // HANDLE
    int InSyncState,   // CF_IN_SYNC_STATE
    int InSyncFlags,   // CF_SET_IN_SYNC_FLAGS
    long* InSyncUsn   // LONGLONG* optional, in/out
);
ccall((:CfSetInSyncState, "cldapi.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32, Int32, Ptr{Int64}),
      FileHandle, InSyncState, InSyncFlags, InSyncUsn)
# FileHandle : HANDLE -> Ptr{Cvoid}
# InSyncState : CF_IN_SYNC_STATE -> Int32
# InSyncFlags : CF_SET_IN_SYNC_FLAGS -> Int32
# InSyncUsn : LONGLONG* optional, in/out -> Ptr{Int64}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CfSetInSyncState(
    void* FileHandle,
    int32_t InSyncState,
    int32_t InSyncFlags,
    int64_t* InSyncUsn);
]]
local cldapi = ffi.load("cldapi")
-- cldapi.CfSetInSyncState(FileHandle, InSyncState, InSyncFlags, InSyncUsn)
-- FileHandle : HANDLE
-- InSyncState : CF_IN_SYNC_STATE
-- InSyncFlags : CF_SET_IN_SYNC_FLAGS
-- InSyncUsn : LONGLONG* optional, in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('cldapi.dll');
const CfSetInSyncState = lib.func('__stdcall', 'CfSetInSyncState', 'int32_t', ['void *', 'int32_t', 'int32_t', 'int64_t *']);
// CfSetInSyncState(FileHandle, InSyncState, InSyncFlags, InSyncUsn)
// FileHandle : HANDLE -> 'void *'
// InSyncState : CF_IN_SYNC_STATE -> 'int32_t'
// InSyncFlags : CF_SET_IN_SYNC_FLAGS -> 'int32_t'
// InSyncUsn : LONGLONG* optional, in/out -> 'int64_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("cldapi.dll", {
  CfSetInSyncState: { parameters: ["pointer", "i32", "i32", "pointer"], result: "i32" },
});
// lib.symbols.CfSetInSyncState(FileHandle, InSyncState, InSyncFlags, InSyncUsn)
// FileHandle : HANDLE -> "pointer"
// InSyncState : CF_IN_SYNC_STATE -> "i32"
// InSyncFlags : CF_SET_IN_SYNC_FLAGS -> "i32"
// InSyncUsn : LONGLONG* optional, in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CfSetInSyncState(
    void* FileHandle,
    int32_t InSyncState,
    int32_t InSyncFlags,
    int64_t* InSyncUsn);
C, "cldapi.dll");
// $ffi->CfSetInSyncState(FileHandle, InSyncState, InSyncFlags, InSyncUsn);
// FileHandle : HANDLE
// InSyncState : CF_IN_SYNC_STATE
// InSyncFlags : CF_SET_IN_SYNC_FLAGS
// InSyncUsn : LONGLONG* optional, in/out
// 構造体/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 CfSetInSyncState(
        Pointer FileHandle,   // HANDLE
        int InSyncState,   // CF_IN_SYNC_STATE
        int InSyncFlags,   // CF_SET_IN_SYNC_FLAGS
        LongByReference InSyncUsn   // LONGLONG* optional, in/out
    );
}
@[Link("cldapi")]
lib Libcldapi
  fun CfSetInSyncState = CfSetInSyncState(
    FileHandle : Void*,   # HANDLE
    InSyncState : Int32,   # CF_IN_SYNC_STATE
    InSyncFlags : Int32,   # CF_SET_IN_SYNC_FLAGS
    InSyncUsn : Int64*   # LONGLONG* optional, in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CfSetInSyncStateNative = Int32 Function(Pointer<Void>, Int32, Int32, Pointer<Int64>);
typedef CfSetInSyncStateDart = int Function(Pointer<Void>, int, int, Pointer<Int64>);
final CfSetInSyncState = DynamicLibrary.open('cldapi.dll')
    .lookupFunction<CfSetInSyncStateNative, CfSetInSyncStateDart>('CfSetInSyncState');
// FileHandle : HANDLE -> Pointer<Void>
// InSyncState : CF_IN_SYNC_STATE -> Int32
// InSyncFlags : CF_SET_IN_SYNC_FLAGS -> Int32
// InSyncUsn : LONGLONG* optional, in/out -> Pointer<Int64>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CfSetInSyncState(
  FileHandle: THandle;   // HANDLE
  InSyncState: Integer;   // CF_IN_SYNC_STATE
  InSyncFlags: Integer;   // CF_SET_IN_SYNC_FLAGS
  InSyncUsn: Pointer   // LONGLONG* optional, in/out
): Integer; stdcall;
  external 'cldapi.dll' name 'CfSetInSyncState';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CfSetInSyncState"
  c_CfSetInSyncState :: Ptr () -> Int32 -> Int32 -> Ptr Int64 -> IO Int32
-- FileHandle : HANDLE -> Ptr ()
-- InSyncState : CF_IN_SYNC_STATE -> Int32
-- InSyncFlags : CF_SET_IN_SYNC_FLAGS -> Int32
-- InSyncUsn : LONGLONG* optional, in/out -> Ptr Int64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cfsetinsyncstate =
  foreign "CfSetInSyncState"
    ((ptr void) @-> int32_t @-> int32_t @-> (ptr int64_t) @-> returning int32_t)
(* FileHandle : HANDLE -> (ptr void) *)
(* InSyncState : CF_IN_SYNC_STATE -> int32_t *)
(* InSyncFlags : CF_SET_IN_SYNC_FLAGS -> int32_t *)
(* InSyncUsn : LONGLONG* optional, in/out -> (ptr int64_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library cldapi (t "cldapi.dll"))
(cffi:use-foreign-library cldapi)

(cffi:defcfun ("CfSetInSyncState" cf-set-in-sync-state :convention :stdcall) :int32
  (file-handle :pointer)   ; HANDLE
  (in-sync-state :int32)   ; CF_IN_SYNC_STATE
  (in-sync-flags :int32)   ; CF_SET_IN_SYNC_FLAGS
  (in-sync-usn :pointer))   ; LONGLONG* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CfSetInSyncState = Win32::API::More->new('cldapi',
    'int CfSetInSyncState(HANDLE FileHandle, int InSyncState, int InSyncFlags, LPVOID InSyncUsn)');
# my $ret = $CfSetInSyncState->Call($FileHandle, $InSyncState, $InSyncFlags, $InSyncUsn);
# FileHandle : HANDLE -> HANDLE
# InSyncState : CF_IN_SYNC_STATE -> int
# InSyncFlags : CF_SET_IN_SYNC_FLAGS -> int
# InSyncUsn : LONGLONG* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型