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

CfUpdatePlaceholder

関数
プレースホルダーのメタデータやデータ範囲を更新する。
DLLcldapi.dll呼出規約winapi対応OSWindows 10 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

HRESULT CfUpdatePlaceholder(
    HANDLE FileHandle,
    const CF_FS_METADATA* FsMetadata,   // optional
    const void* FileIdentity,   // optional
    DWORD FileIdentityLength,
    const CF_FILE_RANGE* DehydrateRangeArray,   // optional
    DWORD DehydrateRangeCount,
    CF_UPDATE_FLAGS UpdateFlags,
    LONGLONG* UpdateUsn,   // optional
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前型方向説明
FileHandleHANDLEin更新する対象プレースホルダーファイルのハンドル。
FsMetadataCF_FS_METADATA*inoptional更新するファイルサイズや属性等を保持するCF_FS_METADATA構造体へのポインタ。NULL可。
FileIdentityvoid*inoptional更新後のプロバイダー定義ファイル識別情報へのポインタ。NULL可。
FileIdentityLengthDWORDinFileIdentityのバイト長。
DehydrateRangeArrayCF_FILE_RANGE*inoptional脱水化(データ破棄)する範囲を指定するCF_FILE_RANGE配列へのポインタ。NULL可。
DehydrateRangeCountDWORDinDehydrateRangeArrayの要素数。
UpdateFlagsCF_UPDATE_FLAGSin更新動作を制御するCF_UPDATE_FLAGSフラグ。
UpdateUsnLONGLONG*inoutoptional更新後のUSN値を受け取るLONGLONGへのポインタ。入出力用。NULL可。
OverlappedOVERLAPPED*inoutoptional非同期処理に用いるOVERLAPPED構造体へのポインタ。同期処理ならNULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT CfUpdatePlaceholder(
    HANDLE FileHandle,
    const CF_FS_METADATA* FsMetadata,   // optional
    const void* FileIdentity,   // optional
    DWORD FileIdentityLength,
    const CF_FILE_RANGE* DehydrateRangeArray,   // optional
    DWORD DehydrateRangeCount,
    CF_UPDATE_FLAGS UpdateFlags,
    LONGLONG* UpdateUsn,   // optional
    OVERLAPPED* Overlapped   // optional
);
[DllImport("cldapi.dll", ExactSpelling = true)]
static extern int CfUpdatePlaceholder(
    IntPtr FileHandle,   // HANDLE
    IntPtr FsMetadata,   // CF_FS_METADATA* optional
    IntPtr FileIdentity,   // void* optional
    uint FileIdentityLength,   // DWORD
    IntPtr DehydrateRangeArray,   // CF_FILE_RANGE* optional
    uint DehydrateRangeCount,   // DWORD
    int UpdateFlags,   // CF_UPDATE_FLAGS
    IntPtr UpdateUsn,   // LONGLONG* optional, in/out
    IntPtr Overlapped   // OVERLAPPED* optional, in/out
);
<DllImport("cldapi.dll", ExactSpelling:=True)>
Public Shared Function CfUpdatePlaceholder(
    FileHandle As IntPtr,   ' HANDLE
    FsMetadata As IntPtr,   ' CF_FS_METADATA* optional
    FileIdentity As IntPtr,   ' void* optional
    FileIdentityLength As UInteger,   ' DWORD
    DehydrateRangeArray As IntPtr,   ' CF_FILE_RANGE* optional
    DehydrateRangeCount As UInteger,   ' DWORD
    UpdateFlags As Integer,   ' CF_UPDATE_FLAGS
    UpdateUsn As IntPtr,   ' LONGLONG* optional, in/out
    Overlapped As IntPtr   ' OVERLAPPED* optional, in/out
) As Integer
End Function
' FileHandle : HANDLE
' FsMetadata : CF_FS_METADATA* optional
' FileIdentity : void* optional
' FileIdentityLength : DWORD
' DehydrateRangeArray : CF_FILE_RANGE* optional
' DehydrateRangeCount : DWORD
' UpdateFlags : CF_UPDATE_FLAGS
' UpdateUsn : LONGLONG* optional, in/out
' Overlapped : OVERLAPPED* optional, in/out
Declare PtrSafe Function CfUpdatePlaceholder Lib "cldapi" ( _
    ByVal FileHandle As LongPtr, _
    ByVal FsMetadata As LongPtr, _
    ByVal FileIdentity As LongPtr, _
    ByVal FileIdentityLength As Long, _
    ByVal DehydrateRangeArray As LongPtr, _
    ByVal DehydrateRangeCount As Long, _
    ByVal UpdateFlags As Long, _
    ByVal UpdateUsn As LongPtr, _
    ByVal Overlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CfUpdatePlaceholder = ctypes.windll.cldapi.CfUpdatePlaceholder
CfUpdatePlaceholder.restype = ctypes.c_int
CfUpdatePlaceholder.argtypes = [
    wintypes.HANDLE,  # FileHandle : HANDLE
    ctypes.c_void_p,  # FsMetadata : CF_FS_METADATA* optional
    ctypes.POINTER(None),  # FileIdentity : void* optional
    wintypes.DWORD,  # FileIdentityLength : DWORD
    ctypes.c_void_p,  # DehydrateRangeArray : CF_FILE_RANGE* optional
    wintypes.DWORD,  # DehydrateRangeCount : DWORD
    ctypes.c_int,  # UpdateFlags : CF_UPDATE_FLAGS
    ctypes.POINTER(ctypes.c_longlong),  # UpdateUsn : LONGLONG* optional, in/out
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional, in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	cldapi = windows.NewLazySystemDLL("cldapi.dll")
	procCfUpdatePlaceholder = cldapi.NewProc("CfUpdatePlaceholder")
)

// FileHandle (HANDLE), FsMetadata (CF_FS_METADATA* optional), FileIdentity (void* optional), FileIdentityLength (DWORD), DehydrateRangeArray (CF_FILE_RANGE* optional), DehydrateRangeCount (DWORD), UpdateFlags (CF_UPDATE_FLAGS), UpdateUsn (LONGLONG* optional, in/out), Overlapped (OVERLAPPED* optional, in/out)
r1, _, err := procCfUpdatePlaceholder.Call(
	uintptr(FileHandle),
	uintptr(FsMetadata),
	uintptr(FileIdentity),
	uintptr(FileIdentityLength),
	uintptr(DehydrateRangeArray),
	uintptr(DehydrateRangeCount),
	uintptr(UpdateFlags),
	uintptr(UpdateUsn),
	uintptr(Overlapped),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function CfUpdatePlaceholder(
  FileHandle: THandle;   // HANDLE
  FsMetadata: Pointer;   // CF_FS_METADATA* optional
  FileIdentity: Pointer;   // void* optional
  FileIdentityLength: DWORD;   // DWORD
  DehydrateRangeArray: Pointer;   // CF_FILE_RANGE* optional
  DehydrateRangeCount: DWORD;   // DWORD
  UpdateFlags: Integer;   // CF_UPDATE_FLAGS
  UpdateUsn: Pointer;   // LONGLONG* optional, in/out
  Overlapped: Pointer   // OVERLAPPED* optional, in/out
): Integer; stdcall;
  external 'cldapi.dll' name 'CfUpdatePlaceholder';
result := DllCall("cldapi\CfUpdatePlaceholder"
    , "Ptr", FileHandle   ; HANDLE
    , "Ptr", FsMetadata   ; CF_FS_METADATA* optional
    , "Ptr", FileIdentity   ; void* optional
    , "UInt", FileIdentityLength   ; DWORD
    , "Ptr", DehydrateRangeArray   ; CF_FILE_RANGE* optional
    , "UInt", DehydrateRangeCount   ; DWORD
    , "Int", UpdateFlags   ; CF_UPDATE_FLAGS
    , "Ptr", UpdateUsn   ; LONGLONG* optional, in/out
    , "Ptr", Overlapped   ; OVERLAPPED* optional, in/out
    , "Int")   ; return: HRESULT
●CfUpdatePlaceholder(FileHandle, FsMetadata, FileIdentity, FileIdentityLength, DehydrateRangeArray, DehydrateRangeCount, UpdateFlags, UpdateUsn, Overlapped) = DLL("cldapi.dll", "int CfUpdatePlaceholder(void*, void*, void*, dword, void*, dword, int, void*, void*)")
# 呼び出し: CfUpdatePlaceholder(FileHandle, FsMetadata, FileIdentity, FileIdentityLength, DehydrateRangeArray, DehydrateRangeCount, UpdateFlags, UpdateUsn, Overlapped)
# FileHandle : HANDLE -> "void*"
# FsMetadata : CF_FS_METADATA* optional -> "void*"
# FileIdentity : void* optional -> "void*"
# FileIdentityLength : DWORD -> "dword"
# DehydrateRangeArray : CF_FILE_RANGE* optional -> "void*"
# DehydrateRangeCount : DWORD -> "dword"
# UpdateFlags : CF_UPDATE_FLAGS -> "int"
# UpdateUsn : LONGLONG* optional, in/out -> "void*"
# Overlapped : OVERLAPPED* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

foreign import stdcall safe "CfUpdatePlaceholder"
  c_CfUpdatePlaceholder :: Ptr () -> Ptr () -> Ptr () -> Word32 -> Ptr () -> Word32 -> Int32 -> Ptr Int64 -> Ptr () -> IO Int32
-- FileHandle : HANDLE -> Ptr ()
-- FsMetadata : CF_FS_METADATA* optional -> Ptr ()
-- FileIdentity : void* optional -> Ptr ()
-- FileIdentityLength : DWORD -> Word32
-- DehydrateRangeArray : CF_FILE_RANGE* optional -> Ptr ()
-- DehydrateRangeCount : DWORD -> Word32
-- UpdateFlags : CF_UPDATE_FLAGS -> Int32
-- UpdateUsn : LONGLONG* optional, in/out -> Ptr Int64
-- Overlapped : OVERLAPPED* optional, in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cfupdateplaceholder =
  foreign "CfUpdatePlaceholder"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> uint32_t @-> (ptr void) @-> uint32_t @-> int32_t @-> (ptr int64_t) @-> (ptr void) @-> returning int32_t)
(* FileHandle : HANDLE -> (ptr void) *)
(* FsMetadata : CF_FS_METADATA* optional -> (ptr void) *)
(* FileIdentity : void* optional -> (ptr void) *)
(* FileIdentityLength : DWORD -> uint32_t *)
(* DehydrateRangeArray : CF_FILE_RANGE* optional -> (ptr void) *)
(* DehydrateRangeCount : DWORD -> uint32_t *)
(* UpdateFlags : CF_UPDATE_FLAGS -> int32_t *)
(* UpdateUsn : LONGLONG* optional, in/out -> (ptr int64_t) *)
(* Overlapped : OVERLAPPED* optional, 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 ("CfUpdatePlaceholder" cf-update-placeholder :convention :stdcall) :int32
  (file-handle :pointer)   ; HANDLE
  (fs-metadata :pointer)   ; CF_FS_METADATA* optional
  (file-identity :pointer)   ; void* optional
  (file-identity-length :uint32)   ; DWORD
  (dehydrate-range-array :pointer)   ; CF_FILE_RANGE* optional
  (dehydrate-range-count :uint32)   ; DWORD
  (update-flags :int32)   ; CF_UPDATE_FLAGS
  (update-usn :pointer)   ; LONGLONG* optional, in/out
  (overlapped :pointer))   ; OVERLAPPED* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CfUpdatePlaceholder = Win32::API::More->new('cldapi',
    'int CfUpdatePlaceholder(HANDLE FileHandle, LPVOID FsMetadata, LPVOID FileIdentity, DWORD FileIdentityLength, LPVOID DehydrateRangeArray, DWORD DehydrateRangeCount, int UpdateFlags, LPVOID UpdateUsn, LPVOID Overlapped)');
# my $ret = $CfUpdatePlaceholder->Call($FileHandle, $FsMetadata, $FileIdentity, $FileIdentityLength, $DehydrateRangeArray, $DehydrateRangeCount, $UpdateFlags, $UpdateUsn, $Overlapped);
# FileHandle : HANDLE -> HANDLE
# FsMetadata : CF_FS_METADATA* optional -> LPVOID
# FileIdentity : void* optional -> LPVOID
# FileIdentityLength : DWORD -> DWORD
# DehydrateRangeArray : CF_FILE_RANGE* optional -> LPVOID
# DehydrateRangeCount : DWORD -> DWORD
# UpdateFlags : CF_UPDATE_FLAGS -> int
# UpdateUsn : LONGLONG* optional, in/out -> LPVOID
# Overlapped : OVERLAPPED* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型