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

CfExecute

関数
クラウドファイル操作を同期プロバイダーから実行する。
DLLcldapi.dll呼出規約winapi対応OSWindows 10 以降

シグネチャ

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

HRESULT CfExecute(
    const CF_OPERATION_INFO* OpInfo,
    CF_OPERATION_PARAMETERS* OpParams
);

パラメーター

名前方向説明
OpInfoCF_OPERATION_INFO*in実行する操作の種別やキー等を記述したCF_OPERATION_INFO構造体へのポインタ。
OpParamsCF_OPERATION_PARAMETERS*inout操作に応じたパラメータを格納したCF_OPERATION_PARAMETERS構造体へのポインタ。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT CfExecute(
    const CF_OPERATION_INFO* OpInfo,
    CF_OPERATION_PARAMETERS* OpParams
);
[DllImport("cldapi.dll", ExactSpelling = true)]
static extern int CfExecute(
    IntPtr OpInfo,   // CF_OPERATION_INFO*
    IntPtr OpParams   // CF_OPERATION_PARAMETERS* in/out
);
<DllImport("cldapi.dll", ExactSpelling:=True)>
Public Shared Function CfExecute(
    OpInfo As IntPtr,   ' CF_OPERATION_INFO*
    OpParams As IntPtr   ' CF_OPERATION_PARAMETERS* in/out
) As Integer
End Function
' OpInfo : CF_OPERATION_INFO*
' OpParams : CF_OPERATION_PARAMETERS* in/out
Declare PtrSafe Function CfExecute Lib "cldapi" ( _
    ByVal OpInfo As LongPtr, _
    ByVal OpParams As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CfExecute = ctypes.windll.cldapi.CfExecute
CfExecute.restype = ctypes.c_int
CfExecute.argtypes = [
    ctypes.c_void_p,  # OpInfo : CF_OPERATION_INFO*
    ctypes.c_void_p,  # OpParams : CF_OPERATION_PARAMETERS* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	cldapi = windows.NewLazySystemDLL("cldapi.dll")
	procCfExecute = cldapi.NewProc("CfExecute")
)

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

extern "cldapi" fn CfExecute(
    OpInfo: [*c]CF_OPERATION_INFO, // CF_OPERATION_INFO*
    OpParams: [*c]CF_OPERATION_PARAMETERS // CF_OPERATION_PARAMETERS* in/out
) callconv(std.os.windows.WINAPI) i32;
proc CfExecute(
    OpInfo: ptr CF_OPERATION_INFO,  # CF_OPERATION_INFO*
    OpParams: ptr CF_OPERATION_PARAMETERS  # CF_OPERATION_PARAMETERS* in/out
): int32 {.importc: "CfExecute", stdcall, dynlib: "cldapi.dll".}
pragma(lib, "cldapi");
extern(Windows)
int CfExecute(
    CF_OPERATION_INFO* OpInfo,   // CF_OPERATION_INFO*
    CF_OPERATION_PARAMETERS* OpParams   // CF_OPERATION_PARAMETERS* in/out
);
ccall((:CfExecute, "cldapi.dll"), stdcall, Int32,
      (Ptr{CF_OPERATION_INFO}, Ptr{CF_OPERATION_PARAMETERS}),
      OpInfo, OpParams)
# OpInfo : CF_OPERATION_INFO* -> Ptr{CF_OPERATION_INFO}
# OpParams : CF_OPERATION_PARAMETERS* in/out -> Ptr{CF_OPERATION_PARAMETERS}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t CfExecute(
    void* OpInfo,
    void* OpParams);
]]
local cldapi = ffi.load("cldapi")
-- cldapi.CfExecute(OpInfo, OpParams)
-- OpInfo : CF_OPERATION_INFO*
-- OpParams : CF_OPERATION_PARAMETERS* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('cldapi.dll');
const CfExecute = lib.func('__stdcall', 'CfExecute', 'int32_t', ['void *', 'void *']);
// CfExecute(OpInfo, OpParams)
// OpInfo : CF_OPERATION_INFO* -> 'void *'
// OpParams : CF_OPERATION_PARAMETERS* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("cldapi.dll", {
  CfExecute: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.CfExecute(OpInfo, OpParams)
// OpInfo : CF_OPERATION_INFO* -> "pointer"
// OpParams : CF_OPERATION_PARAMETERS* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t CfExecute(
    void* OpInfo,
    void* OpParams);
C, "cldapi.dll");
// $ffi->CfExecute(OpInfo, OpParams);
// OpInfo : CF_OPERATION_INFO*
// OpParams : CF_OPERATION_PARAMETERS* 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 CfExecute(
        Pointer OpInfo,   // CF_OPERATION_INFO*
        Pointer OpParams   // CF_OPERATION_PARAMETERS* in/out
    );
}
@[Link("cldapi")]
lib Libcldapi
  fun CfExecute = CfExecute(
    OpInfo : CF_OPERATION_INFO*,   # CF_OPERATION_INFO*
    OpParams : CF_OPERATION_PARAMETERS*   # CF_OPERATION_PARAMETERS* 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 CfExecuteNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef CfExecuteDart = int Function(Pointer<Void>, Pointer<Void>);
final CfExecute = DynamicLibrary.open('cldapi.dll')
    .lookupFunction<CfExecuteNative, CfExecuteDart>('CfExecute');
// OpInfo : CF_OPERATION_INFO* -> Pointer<Void>
// OpParams : CF_OPERATION_PARAMETERS* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CfExecute(
  OpInfo: Pointer;   // CF_OPERATION_INFO*
  OpParams: Pointer   // CF_OPERATION_PARAMETERS* in/out
): Integer; stdcall;
  external 'cldapi.dll' name 'CfExecute';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CfExecute"
  c_CfExecute :: Ptr () -> Ptr () -> IO Int32
-- OpInfo : CF_OPERATION_INFO* -> Ptr ()
-- OpParams : CF_OPERATION_PARAMETERS* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cfexecute =
  foreign "CfExecute"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* OpInfo : CF_OPERATION_INFO* -> (ptr void) *)
(* OpParams : CF_OPERATION_PARAMETERS* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library cldapi (t "cldapi.dll"))
(cffi:use-foreign-library cldapi)

(cffi:defcfun ("CfExecute" cf-execute :convention :stdcall) :int32
  (op-info :pointer)   ; CF_OPERATION_INFO*
  (op-params :pointer))   ; CF_OPERATION_PARAMETERS* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CfExecute = Win32::API::More->new('cldapi',
    'int CfExecute(LPVOID OpInfo, LPVOID OpParams)');
# my $ret = $CfExecute->Call($OpInfo, $OpParams);
# OpInfo : CF_OPERATION_INFO* -> LPVOID
# OpParams : CF_OPERATION_PARAMETERS* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型