ホーム › 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
);

パラメーター

名前	型	方向	説明
FileHandle	HANDLE	in	脱水化(ローカルデータ破棄)する対象プレースホルダーファイルのハンドル。
StartingOffset	LONGLONG	in	脱水化を開始するバイトオフセット。
Length	LONGLONG	in	脱水化する範囲のバイト長。-1で末尾まで全体を指定する。
DehydrateFlags	CF_DEHYDRATE_FLAGS	in	脱水化動作を制御するCF_DEHYDRATE_FLAGSフラグ。
Overlapped	OVERLAPPED*	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 は未対応)。#uselib "cldapi.dll"
#cfunc global CfDehydratePlaceholder "CfDehydratePlaceholder" sptr, int64, int64, int, sptr
; res = CfDehydratePlaceholder(FileHandle, StartingOffset, Length, DehydrateFlags, varptr(Overlapped))
; FileHandle : HANDLE -> "sptr"
; StartingOffset : LONGLONG -> "int64"
; Length : LONGLONG -> "int64"
; DehydrateFlags : CF_DEHYDRATE_FLAGS -> "int"
; Overlapped : OVERLAPPED* optional, in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは 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 方式にも切替可。; 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, intptr
; res = CfDehydratePlaceholder(FileHandle, StartingOffset, Length, DehydrateFlags, varptr(Overlapped))
; FileHandle : HANDLE -> "intptr"
; StartingOffset : LONGLONG -> "int64"
; Length : LONGLONG -> "int64"
; DehydrateFlags : CF_DEHYDRATE_FLAGS -> "int"
; Overlapped : OVERLAPPED* optional, in/out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは 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)。