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

CfDehydratePlaceholder

関数
プレースホルダーの実データを解放し脱水化する。
DLLcldapi.dll呼出規約winapi

シグネチャ

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

HRESULT CfDehydratePlaceholder(
    HANDLE FileHandle,
    LONGLONG StartingOffset,
    LONGLONG Length,
    CF_DEHYDRATE_FLAGS DehydrateFlags,
    OVERLAPPED* Overlapped   // optional
);

パラメーター

名前型方向説明
FileHandleHANDLEin脱水化(ローカルデータ破棄)する対象プレースホルダーファイルのハンドル。
StartingOffsetLONGLONGin脱水化を開始するバイトオフセット。
LengthLONGLONGin脱水化する範囲のバイト長。-1で末尾まで全体を指定する。
DehydrateFlagsCF_DEHYDRATE_FLAGSin脱水化動作を制御するCF_DEHYDRATE_FLAGSフラグ。
OverlappedOVERLAPPED*inoutoptional非同期処理に用いるOVERLAPPED構造体へのポインタ。同期処理ならNULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

CfDehydratePlaceholder = ctypes.windll.cldapi.CfDehydratePlaceholder
CfDehydratePlaceholder.restype = ctypes.c_int
CfDehydratePlaceholder.argtypes = [
    wintypes.HANDLE,  # FileHandle : HANDLE
    ctypes.c_longlong,  # StartingOffset : LONGLONG
    ctypes.c_longlong,  # Length : LONGLONG
    ctypes.c_int,  # DehydrateFlags : CF_DEHYDRATE_FLAGS
    ctypes.c_void_p,  # Overlapped : OVERLAPPED* optional, in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('cldapi.dll')
CfDehydratePlaceholder = Fiddle::Function.new(
  lib['CfDehydratePlaceholder'],
  [
    Fiddle::TYPE_VOIDP,  # FileHandle : HANDLE
    Fiddle::TYPE_LONG_LONG,  # StartingOffset : LONGLONG
    Fiddle::TYPE_LONG_LONG,  # Length : LONGLONG
    Fiddle::TYPE_INT,  # DehydrateFlags : CF_DEHYDRATE_FLAGS
    Fiddle::TYPE_VOIDP,  # Overlapped : OVERLAPPED* optional, in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "cldapi")]
extern "system" {
    fn CfDehydratePlaceholder(
        FileHandle: *mut core::ffi::c_void,  // HANDLE
        StartingOffset: i64,  // LONGLONG
        Length: i64,  // LONGLONG
        DehydrateFlags: i32,  // CF_DEHYDRATE_FLAGS
        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 CfDehydratePlaceholder(IntPtr FileHandle, long StartingOffset, long Length, int DehydrateFlags, IntPtr Overlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'cldapi_CfDehydratePlaceholder' -Namespace Win32 -PassThru
# $api::CfDehydratePlaceholder(FileHandle, StartingOffset, Length, DehydrateFlags, Overlapped)
#uselib "cldapi.dll"
#func global CfDehydratePlaceholder "CfDehydratePlaceholder" sptr, sptr, sptr, sptr, sptr
; CfDehydratePlaceholder FileHandle, StartingOffset, Length, DehydrateFlags, varptr(Overlapped)   ; 戻り値は stat
; FileHandle : HANDLE -> "sptr"
; StartingOffset : LONGLONG -> "sptr"
; Length : LONGLONG -> "sptr"
; DehydrateFlags : CF_DEHYDRATE_FLAGS -> "sptr"
; Overlapped : OVERLAPPED* optional, in/out -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "cldapi.dll"
#cfunc global CfDehydratePlaceholder "CfDehydratePlaceholder" sptr, int64, int64, int, var
; res = CfDehydratePlaceholder(FileHandle, StartingOffset, Length, DehydrateFlags, Overlapped)
; FileHandle : HANDLE -> "sptr"
; StartingOffset : LONGLONG -> "int64"
; Length : LONGLONG -> "int64"
; DehydrateFlags : CF_DEHYDRATE_FLAGS -> "int"
; Overlapped : OVERLAPPED* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数: 
; HRESULT CfDehydratePlaceholder(HANDLE FileHandle, LONGLONG StartingOffset, LONGLONG Length, CF_DEHYDRATE_FLAGS DehydrateFlags, OVERLAPPED* Overlapped)
#uselib "cldapi.dll"
#cfunc global CfDehydratePlaceholder "CfDehydratePlaceholder" intptr, int64, int64, int, var
; res = CfDehydratePlaceholder(FileHandle, StartingOffset, Length, DehydrateFlags, Overlapped)
; FileHandle : HANDLE -> "intptr"
; StartingOffset : LONGLONG -> "int64"
; Length : LONGLONG -> "int64"
; DehydrateFlags : CF_DEHYDRATE_FLAGS -> "int"
; Overlapped : OVERLAPPED* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	cldapi = windows.NewLazySystemDLL("cldapi.dll")
	procCfDehydratePlaceholder = cldapi.NewProc("CfDehydratePlaceholder")
)

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

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

foreign import stdcall safe "CfDehydratePlaceholder"
  c_CfDehydratePlaceholder :: Ptr () -> Int64 -> Int64 -> Int32 -> Ptr () -> IO Int32
-- FileHandle : HANDLE -> Ptr ()
-- StartingOffset : LONGLONG -> Int64
-- Length : LONGLONG -> Int64
-- DehydrateFlags : CF_DEHYDRATE_FLAGS -> Int32
-- Overlapped : OVERLAPPED* optional, in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cfdehydrateplaceholder =
  foreign "CfDehydratePlaceholder"
    ((ptr void) @-> int64_t @-> int64_t @-> int32_t @-> (ptr void) @-> returning int32_t)
(* FileHandle : HANDLE -> (ptr void) *)
(* StartingOffset : LONGLONG -> int64_t *)
(* Length : LONGLONG -> int64_t *)
(* DehydrateFlags : CF_DEHYDRATE_FLAGS -> int32_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 ("CfDehydratePlaceholder" cf-dehydrate-placeholder :convention :stdcall) :int32
  (file-handle :pointer)   ; HANDLE
  (starting-offset :int64)   ; LONGLONG
  (length :int64)   ; LONGLONG
  (dehydrate-flags :int32)   ; CF_DEHYDRATE_FLAGS
  (overlapped :pointer))   ; OVERLAPPED* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CfDehydratePlaceholder = Win32::API::More->new('cldapi',
    'int CfDehydratePlaceholder(HANDLE FileHandle, INT64 StartingOffset, INT64 Length, int DehydrateFlags, LPVOID Overlapped)');
# my $ret = $CfDehydratePlaceholder->Call($FileHandle, $StartingOffset, $Length, $DehydrateFlags, $Overlapped);
# FileHandle : HANDLE -> HANDLE
# StartingOffset : LONGLONG -> INT64
# Length : LONGLONG -> INT64
# DehydrateFlags : CF_DEHYDRATE_FLAGS -> int
# Overlapped : OVERLAPPED* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型