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

WofShouldCompressBinaries

関数
ボリュームでバイナリ圧縮すべきかと圧縮方式を判定する。
DLLWOFUTIL.dll呼出規約winapi

シグネチャ

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

BOOL WofShouldCompressBinaries(
    LPCWSTR Volume,
    DWORD* Algorithm
);

パラメーター

名前方向説明
VolumeLPCWSTRin圧縮状態を取得したいボリュームのパスを指定します。
AlgorithmDWORD*outULONG 値を指すポインターです。関数が TRUE を返して圧縮が望ましいことを示す場合、この値にはこのボリュームで使用すべきアルゴリズムが格納されます。

戻り値の型: BOOL

公式ドキュメント

特定のボリュームで圧縮を使用すべきかどうか、また使用する場合はどの圧縮アルゴリズムを使用すべきかを示します。

戻り値

このボリューム上のバイナリを圧縮すべき場合、戻り値は TRUE です。それ以外の場合は FALSE です。指定されたボリュームでシステムが圧縮をサポートしていない場合、この関数は FALSE を返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL WofShouldCompressBinaries(
    LPCWSTR Volume,
    DWORD* Algorithm
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WOFUTIL.dll", ExactSpelling = true)]
static extern bool WofShouldCompressBinaries(
    [MarshalAs(UnmanagedType.LPWStr)] string Volume,   // LPCWSTR
    out uint Algorithm   // DWORD* out
);
<DllImport("WOFUTIL.dll", ExactSpelling:=True)>
Public Shared Function WofShouldCompressBinaries(
    <MarshalAs(UnmanagedType.LPWStr)> Volume As String,   ' LPCWSTR
    <Out> ByRef Algorithm As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' Volume : LPCWSTR
' Algorithm : DWORD* out
Declare PtrSafe Function WofShouldCompressBinaries Lib "wofutil" ( _
    ByVal Volume As LongPtr, _
    ByRef Algorithm As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WofShouldCompressBinaries = ctypes.windll.wofutil.WofShouldCompressBinaries
WofShouldCompressBinaries.restype = wintypes.BOOL
WofShouldCompressBinaries.argtypes = [
    wintypes.LPCWSTR,  # Volume : LPCWSTR
    ctypes.POINTER(wintypes.DWORD),  # Algorithm : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WOFUTIL.dll')
WofShouldCompressBinaries = Fiddle::Function.new(
  lib['WofShouldCompressBinaries'],
  [
    Fiddle::TYPE_VOIDP,  # Volume : LPCWSTR
    Fiddle::TYPE_VOIDP,  # Algorithm : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "wofutil")]
extern "system" {
    fn WofShouldCompressBinaries(
        Volume: *const u16,  // LPCWSTR
        Algorithm: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WOFUTIL.dll")]
public static extern bool WofShouldCompressBinaries([MarshalAs(UnmanagedType.LPWStr)] string Volume, out uint Algorithm);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WOFUTIL_WofShouldCompressBinaries' -Namespace Win32 -PassThru
# $api::WofShouldCompressBinaries(Volume, Algorithm)
#uselib "WOFUTIL.dll"
#func global WofShouldCompressBinaries "WofShouldCompressBinaries" sptr, sptr
; WofShouldCompressBinaries Volume, varptr(Algorithm)   ; 戻り値は stat
; Volume : LPCWSTR -> "sptr"
; Algorithm : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WOFUTIL.dll"
#cfunc global WofShouldCompressBinaries "WofShouldCompressBinaries" wstr, var
; res = WofShouldCompressBinaries(Volume, Algorithm)
; Volume : LPCWSTR -> "wstr"
; Algorithm : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL WofShouldCompressBinaries(LPCWSTR Volume, DWORD* Algorithm)
#uselib "WOFUTIL.dll"
#cfunc global WofShouldCompressBinaries "WofShouldCompressBinaries" wstr, var
; res = WofShouldCompressBinaries(Volume, Algorithm)
; Volume : LPCWSTR -> "wstr"
; Algorithm : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wofutil = windows.NewLazySystemDLL("WOFUTIL.dll")
	procWofShouldCompressBinaries = wofutil.NewProc("WofShouldCompressBinaries")
)

// Volume (LPCWSTR), Algorithm (DWORD* out)
r1, _, err := procWofShouldCompressBinaries.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(Volume))),
	uintptr(Algorithm),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WofShouldCompressBinaries(
  Volume: PWideChar;   // LPCWSTR
  Algorithm: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WOFUTIL.dll' name 'WofShouldCompressBinaries';
result := DllCall("WOFUTIL\WofShouldCompressBinaries"
    , "WStr", Volume   ; LPCWSTR
    , "Ptr", Algorithm   ; DWORD* out
    , "Int")   ; return: BOOL
●WofShouldCompressBinaries(Volume, Algorithm) = DLL("WOFUTIL.dll", "bool WofShouldCompressBinaries(char*, void*)")
# 呼び出し: WofShouldCompressBinaries(Volume, Algorithm)
# Volume : LPCWSTR -> "char*"
# Algorithm : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wofutil" fn WofShouldCompressBinaries(
    Volume: [*c]const u16, // LPCWSTR
    Algorithm: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
proc WofShouldCompressBinaries(
    Volume: WideCString,  # LPCWSTR
    Algorithm: ptr uint32  # DWORD* out
): int32 {.importc: "WofShouldCompressBinaries", stdcall, dynlib: "WOFUTIL.dll".}
pragma(lib, "wofutil");
extern(Windows)
int WofShouldCompressBinaries(
    const(wchar)* Volume,   // LPCWSTR
    uint* Algorithm   // DWORD* out
);
ccall((:WofShouldCompressBinaries, "WOFUTIL.dll"), stdcall, Int32,
      (Cwstring, Ptr{UInt32}),
      Volume, Algorithm)
# Volume : LPCWSTR -> Cwstring
# Algorithm : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t WofShouldCompressBinaries(
    const uint16_t* Volume,
    uint32_t* Algorithm);
]]
local wofutil = ffi.load("wofutil")
-- wofutil.WofShouldCompressBinaries(Volume, Algorithm)
-- Volume : LPCWSTR
-- Algorithm : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WOFUTIL.dll');
const WofShouldCompressBinaries = lib.func('__stdcall', 'WofShouldCompressBinaries', 'int32_t', ['str16', 'uint32_t *']);
// WofShouldCompressBinaries(Volume, Algorithm)
// Volume : LPCWSTR -> 'str16'
// Algorithm : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WOFUTIL.dll", {
  WofShouldCompressBinaries: { parameters: ["buffer", "pointer"], result: "i32" },
});
// lib.symbols.WofShouldCompressBinaries(Volume, Algorithm)
// Volume : LPCWSTR -> "buffer"
// Algorithm : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t WofShouldCompressBinaries(
    const uint16_t* Volume,
    uint32_t* Algorithm);
C, "WOFUTIL.dll");
// $ffi->WofShouldCompressBinaries(Volume, Algorithm);
// Volume : LPCWSTR
// Algorithm : DWORD* 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 Wofutil extends StdCallLibrary {
    Wofutil INSTANCE = Native.load("wofutil", Wofutil.class);
    boolean WofShouldCompressBinaries(
        WString Volume,   // LPCWSTR
        IntByReference Algorithm   // DWORD* out
    );
}
@[Link("wofutil")]
lib LibWOFUTIL
  fun WofShouldCompressBinaries = WofShouldCompressBinaries(
    Volume : UInt16*,   # LPCWSTR
    Algorithm : UInt32*   # DWORD* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WofShouldCompressBinariesNative = Int32 Function(Pointer<Utf16>, Pointer<Uint32>);
typedef WofShouldCompressBinariesDart = int Function(Pointer<Utf16>, Pointer<Uint32>);
final WofShouldCompressBinaries = DynamicLibrary.open('WOFUTIL.dll')
    .lookupFunction<WofShouldCompressBinariesNative, WofShouldCompressBinariesDart>('WofShouldCompressBinaries');
// Volume : LPCWSTR -> Pointer<Utf16>
// Algorithm : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WofShouldCompressBinaries(
  Volume: PWideChar;   // LPCWSTR
  Algorithm: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WOFUTIL.dll' name 'WofShouldCompressBinaries';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WofShouldCompressBinaries"
  c_WofShouldCompressBinaries :: CWString -> Ptr Word32 -> IO CInt
-- Volume : LPCWSTR -> CWString
-- Algorithm : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wofshouldcompressbinaries =
  foreign "WofShouldCompressBinaries"
    ((ptr uint16_t) @-> (ptr uint32_t) @-> returning int32_t)
(* Volume : LPCWSTR -> (ptr uint16_t) *)
(* Algorithm : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wofutil (t "WOFUTIL.dll"))
(cffi:use-foreign-library wofutil)

(cffi:defcfun ("WofShouldCompressBinaries" wof-should-compress-binaries :convention :stdcall) :int32
  (volume (:string :encoding :utf-16le))   ; LPCWSTR
  (algorithm :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WofShouldCompressBinaries = Win32::API::More->new('WOFUTIL',
    'BOOL WofShouldCompressBinaries(LPCWSTR Volume, LPVOID Algorithm)');
# my $ret = $WofShouldCompressBinaries->Call($Volume, $Algorithm);
# Volume : LPCWSTR -> LPCWSTR
# Algorithm : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。