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

FDITruncateCabinet

関数
FDIで指定フォルダ以降のキャビネットを切り詰める。
DLLCabinet.dll呼出規約cdecl

シグネチャ

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

BOOL FDITruncateCabinet(
    void* hfdi,
    LPSTR pszCabinetName,
    WORD iFolderToDelete
);

パラメーター

名前方向説明
hfdivoid*inFDICreateで取得したFDIコンテキストハンドル。
pszCabinetNameLPSTRin切り詰める対象キャビネットのファイル名を示すASCII文字列。
iFolderToDeleteWORDin削除を開始するフォルダーの0始まりのインデックス。以降のフォルダーが除去される。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL FDITruncateCabinet(
    void* hfdi,
    LPSTR pszCabinetName,
    WORD iFolderToDelete
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("Cabinet.dll", ExactSpelling = true, CallingConvention = CallingConvention.Cdecl)]
static extern bool FDITruncateCabinet(
    IntPtr hfdi,   // void*
    [MarshalAs(UnmanagedType.LPStr)] string pszCabinetName,   // LPSTR
    ushort iFolderToDelete   // WORD
);
<DllImport("Cabinet.dll", ExactSpelling:=True, CallingConvention:=CallingConvention.Cdecl)>
Public Shared Function FDITruncateCabinet(
    hfdi As IntPtr,   ' void*
    <MarshalAs(UnmanagedType.LPStr)> pszCabinetName As String,   ' LPSTR
    iFolderToDelete As UShort   ' WORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hfdi : void*
' pszCabinetName : LPSTR
' iFolderToDelete : WORD
Declare PtrSafe Function FDITruncateCabinet Lib "cabinet" ( _
    ByVal hfdi As LongPtr, _
    ByVal pszCabinetName As String, _
    ByVal iFolderToDelete As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FDITruncateCabinet = ctypes.cdll.cabinet.FDITruncateCabinet
FDITruncateCabinet.restype = wintypes.BOOL
FDITruncateCabinet.argtypes = [
    ctypes.POINTER(None),  # hfdi : void*
    wintypes.LPCSTR,  # pszCabinetName : LPSTR
    ctypes.c_ushort,  # iFolderToDelete : WORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('Cabinet.dll')
FDITruncateCabinet = Fiddle::Function.new(
  lib['FDITruncateCabinet'],
  [
    Fiddle::TYPE_VOIDP,  # hfdi : void*
    Fiddle::TYPE_VOIDP,  # pszCabinetName : LPSTR
    -Fiddle::TYPE_SHORT,  # iFolderToDelete : WORD
  ],
  Fiddle::TYPE_INT, Fiddle::Function::CDECL)
#[link(name = "cabinet")]
extern "C" {
    fn FDITruncateCabinet(
        hfdi: *mut (),  // void*
        pszCabinetName: *mut u8,  // LPSTR
        iFolderToDelete: u16  // WORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("Cabinet.dll", CallingConvention = CallingConvention.Cdecl)]
public static extern bool FDITruncateCabinet(IntPtr hfdi, [MarshalAs(UnmanagedType.LPStr)] string pszCabinetName, ushort iFolderToDelete);
"@
$api = Add-Type -MemberDefinition $sig -Name 'Cabinet_FDITruncateCabinet' -Namespace Win32 -PassThru
# $api::FDITruncateCabinet(hfdi, pszCabinetName, iFolderToDelete)
#uselib "Cabinet.dll"
#func global FDITruncateCabinet "FDITruncateCabinet" sptr, sptr, sptr
; FDITruncateCabinet hfdi, pszCabinetName, iFolderToDelete   ; 戻り値は stat
; hfdi : void* -> "sptr"
; pszCabinetName : LPSTR -> "sptr"
; iFolderToDelete : WORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "Cabinet.dll"
#cfunc global FDITruncateCabinet "FDITruncateCabinet" sptr, str, int
; res = FDITruncateCabinet(hfdi, pszCabinetName, iFolderToDelete)
; hfdi : void* -> "sptr"
; pszCabinetName : LPSTR -> "str"
; iFolderToDelete : WORD -> "int"
; BOOL FDITruncateCabinet(void* hfdi, LPSTR pszCabinetName, WORD iFolderToDelete)
#uselib "Cabinet.dll"
#cfunc global FDITruncateCabinet "FDITruncateCabinet" intptr, str, int
; res = FDITruncateCabinet(hfdi, pszCabinetName, iFolderToDelete)
; hfdi : void* -> "intptr"
; pszCabinetName : LPSTR -> "str"
; iFolderToDelete : WORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	cabinet = windows.NewLazySystemDLL("Cabinet.dll")
	procFDITruncateCabinet = cabinet.NewProc("FDITruncateCabinet")
)

// hfdi (void*), pszCabinetName (LPSTR), iFolderToDelete (WORD)
r1, _, err := procFDITruncateCabinet.Call(
	uintptr(hfdi),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszCabinetName))),
	uintptr(iFolderToDelete),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FDITruncateCabinet(
  hfdi: Pointer;   // void*
  pszCabinetName: PAnsiChar;   // LPSTR
  iFolderToDelete: Word   // WORD
): BOOL; cdecl;
  external 'Cabinet.dll' name 'FDITruncateCabinet';
result := DllCall("Cabinet\FDITruncateCabinet"
    , "Ptr", hfdi   ; void*
    , "AStr", pszCabinetName   ; LPSTR
    , "UShort", iFolderToDelete   ; WORD
    , "Cdecl Int")   ; return: BOOL
●FDITruncateCabinet(hfdi, pszCabinetName, iFolderToDelete) = DLL("Cabinet.dll", "bool FDITruncateCabinet(void*, char*, int)")
# 呼び出し: FDITruncateCabinet(hfdi, pszCabinetName, iFolderToDelete)
# hfdi : void* -> "void*"
# pszCabinetName : LPSTR -> "char*"
# iFolderToDelete : WORD -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※cdecl関数。DLL()宣言はstdcall前提。cdeclは EXEC_PTR(`cdecl`,…) を使用。
const std = @import("std");

extern "cabinet" fn FDITruncateCabinet(
    hfdi: ?*anyopaque, // void*
    pszCabinetName: [*c]const u8, // LPSTR
    iFolderToDelete: u16 // WORD
) callconv(.c) i32;
proc FDITruncateCabinet(
    hfdi: pointer,  # void*
    pszCabinetName: cstring,  # LPSTR
    iFolderToDelete: uint16  # WORD
): int32 {.importc: "FDITruncateCabinet", cdecl, dynlib: "Cabinet.dll".}
pragma(lib, "cabinet");
extern(C)
int FDITruncateCabinet(
    void* hfdi,   // void*
    const(char)* pszCabinetName,   // LPSTR
    ushort iFolderToDelete   // WORD
);
ccall((:FDITruncateCabinet, "Cabinet.dll"), Int32,
      (Ptr{Cvoid}, Cstring, UInt16),
      hfdi, pszCabinetName, iFolderToDelete)
# hfdi : void* -> Ptr{Cvoid}
# pszCabinetName : LPSTR -> Cstring
# iFolderToDelete : WORD -> UInt16
local ffi = require("ffi")
ffi.cdef[[
int32_t FDITruncateCabinet(
    void* hfdi,
    const char* pszCabinetName,
    uint16_t iFolderToDelete);
]]
local cabinet = ffi.load("cabinet")
-- cabinet.FDITruncateCabinet(hfdi, pszCabinetName, iFolderToDelete)
-- hfdi : void*
-- pszCabinetName : LPSTR
-- iFolderToDelete : WORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('Cabinet.dll');
const FDITruncateCabinet = lib.func('__cdecl', 'FDITruncateCabinet', 'int32_t', ['void *', 'str', 'uint16_t']);
// FDITruncateCabinet(hfdi, pszCabinetName, iFolderToDelete)
// hfdi : void* -> 'void *'
// pszCabinetName : LPSTR -> 'str'
// iFolderToDelete : WORD -> 'uint16_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("Cabinet.dll", {
  FDITruncateCabinet: { parameters: ["pointer", "buffer", "u16"], result: "i32" },
});
// lib.symbols.FDITruncateCabinet(hfdi, pszCabinetName, iFolderToDelete)
// hfdi : void* -> "pointer"
// pszCabinetName : LPSTR -> "buffer"
// iFolderToDelete : WORD -> "u16"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FDITruncateCabinet(
    void* hfdi,
    const char* pszCabinetName,
    uint16_t iFolderToDelete);
C, "Cabinet.dll");
// $ffi->FDITruncateCabinet(hfdi, pszCabinetName, iFolderToDelete);
// hfdi : void*
// pszCabinetName : LPSTR
// iFolderToDelete : WORD
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Cabinet extends Library {
    Cabinet INSTANCE = Native.load("cabinet", Cabinet.class);
    boolean FDITruncateCabinet(
        Pointer hfdi,   // void*
        String pszCabinetName,   // LPSTR
        short iFolderToDelete   // WORD
    );
}
@[Link("cabinet")]
lib LibCabinet
  fun FDITruncateCabinet = FDITruncateCabinet(
    hfdi : Void*,   # void*
    pszCabinetName : UInt8*,   # LPSTR
    iFolderToDelete : UInt16   # WORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef FDITruncateCabinetNative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Uint16);
typedef FDITruncateCabinetDart = int Function(Pointer<Void>, Pointer<Utf8>, int);
final FDITruncateCabinet = DynamicLibrary.open('Cabinet.dll')
    .lookupFunction<FDITruncateCabinetNative, FDITruncateCabinetDart>('FDITruncateCabinet');
// hfdi : void* -> Pointer<Void>
// pszCabinetName : LPSTR -> Pointer<Utf8>
// iFolderToDelete : WORD -> Uint16
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FDITruncateCabinet(
  hfdi: Pointer;   // void*
  pszCabinetName: PAnsiChar;   // LPSTR
  iFolderToDelete: Word   // WORD
): BOOL; cdecl;
  external 'Cabinet.dll' name 'FDITruncateCabinet';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import ccall safe "FDITruncateCabinet"
  c_FDITruncateCabinet :: Ptr () -> CString -> Word16 -> IO CInt
-- hfdi : void* -> Ptr ()
-- pszCabinetName : LPSTR -> CString
-- iFolderToDelete : WORD -> Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let fditruncatecabinet =
  foreign "FDITruncateCabinet"
    ((ptr void) @-> string @-> uint16_t @-> returning int32_t)
(* hfdi : void* -> (ptr void) *)
(* pszCabinetName : LPSTR -> string *)
(* iFolderToDelete : WORD -> uint16_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library cabinet (t "Cabinet.dll"))
(cffi:use-foreign-library cabinet)

(cffi:defcfun ("FDITruncateCabinet" fditruncate-cabinet :convention :cdecl) :int32
  (hfdi :pointer)   ; void*
  (psz-cabinet-name :string)   ; LPSTR
  (i-folder-to-delete :uint16))   ; WORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FDITruncateCabinet = Win32::API::More->new('Cabinet',
    'BOOL FDITruncateCabinet(LPVOID hfdi, LPCSTR pszCabinetName, WORD iFolderToDelete)');
# my $ret = $FDITruncateCabinet->Call($hfdi, $pszCabinetName, $iFolderToDelete);
# hfdi : void* -> LPVOID
# pszCabinetName : LPSTR -> LPCSTR
# iFolderToDelete : WORD -> WORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。