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

LZCopy

関数
LZ圧縮されたソースファイルを展開してコピーする。
DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

INT LZCopy(
    INT hfSource,
    INT hfDest
);

パラメーター

名前方向説明
hfSourceINTinソースファイルのハンドル。
hfDestINTin宛先ファイルのハンドル。

戻り値の型: INT

公式ドキュメント

ソースファイルを宛先ファイルにコピーします。

戻り値

関数が成功した場合、戻り値は宛先ファイルのサイズ(バイト単位)を表します。

関数が失敗した場合、戻り値は LZERROR_* コードです。これらのコードはゼロより小さい値を持ちます。なお、 LZCopySetLastErrorSetLastErrorEx も呼び出しません。したがって、その失敗はスレッドのラストエラーコードに影響しません。

以下は、 LZCopy が失敗時に返すことのあるエラーコードの一覧です。

戻りコード 説明
LZERROR_BADINHANDLE
ソースファイルを識別するハンドルが無効です。ファイルを読み取れません。
LZERROR_BADOUTHANDLE
宛先ファイルを識別するハンドルが無効です。ファイルに書き込めません。
LZERROR_GLOBALLOC
開いている圧縮ファイルの最大数を超過したか、ローカルメモリを割り当てられません。
LZERROR_GLOBLOCK
LZ ファイルハンドルをロックできません。
LZERROR_READ
ソースファイルの形式が無効です。

この関数には拡張エラー情報はありません。GetLastError を呼び出さないでください。

解説(Remarks)

ソースファイルおよび宛先ファイルを識別するハンドルは、 LZInit または LZOpenFile 関数を呼び出して取得する必要があります。

関数が成功した場合、hfDest パラメーターで識別されるファイルは常に非圧縮です。

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジでサポートされています。

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 トランスペアレントフェールオーバー (TFO) はい
SMB 3.0 とスケールアウトファイル共有 (SO) はい
クラスター共有ボリュームファイルシステム (CsvFS) はい
回復性のあるファイルシステム (ReFS) はい

CsvFs は圧縮ファイルに対してリダイレクト IO を実行します。

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

各言語での呼び出し定義

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

INT LZCopy(
    INT hfSource,
    INT hfDest
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern int LZCopy(
    int hfSource,   // INT
    int hfDest   // INT
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function LZCopy(
    hfSource As Integer,   ' INT
    hfDest As Integer   ' INT
) As Integer
End Function
' hfSource : INT
' hfDest : INT
Declare PtrSafe Function LZCopy Lib "kernel32" ( _
    ByVal hfSource As Long, _
    ByVal hfDest As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

LZCopy = ctypes.windll.kernel32.LZCopy
LZCopy.restype = ctypes.c_int
LZCopy.argtypes = [
    ctypes.c_int,  # hfSource : INT
    ctypes.c_int,  # hfDest : INT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
LZCopy = Fiddle::Function.new(
  lib['LZCopy'],
  [
    Fiddle::TYPE_INT,  # hfSource : INT
    Fiddle::TYPE_INT,  # hfDest : INT
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn LZCopy(
        hfSource: i32,  // INT
        hfDest: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll")]
public static extern int LZCopy(int hfSource, int hfDest);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_LZCopy' -Namespace Win32 -PassThru
# $api::LZCopy(hfSource, hfDest)
#uselib "KERNEL32.dll"
#func global LZCopy "LZCopy" sptr, sptr
; LZCopy hfSource, hfDest   ; 戻り値は stat
; hfSource : INT -> "sptr"
; hfDest : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global LZCopy "LZCopy" int, int
; res = LZCopy(hfSource, hfDest)
; hfSource : INT -> "int"
; hfDest : INT -> "int"
; INT LZCopy(INT hfSource, INT hfDest)
#uselib "KERNEL32.dll"
#cfunc global LZCopy "LZCopy" int, int
; res = LZCopy(hfSource, hfDest)
; hfSource : INT -> "int"
; hfDest : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procLZCopy = kernel32.NewProc("LZCopy")
)

// hfSource (INT), hfDest (INT)
r1, _, err := procLZCopy.Call(
	uintptr(hfSource),
	uintptr(hfDest),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function LZCopy(
  hfSource: Integer;   // INT
  hfDest: Integer   // INT
): Integer; stdcall;
  external 'KERNEL32.dll' name 'LZCopy';
result := DllCall("KERNEL32\LZCopy"
    , "Int", hfSource   ; INT
    , "Int", hfDest   ; INT
    , "Int")   ; return: INT
●LZCopy(hfSource, hfDest) = DLL("KERNEL32.dll", "int LZCopy(int, int)")
# 呼び出し: LZCopy(hfSource, hfDest)
# hfSource : INT -> "int"
# hfDest : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef LZCopyNative = Int32 Function(Int32, Int32);
typedef LZCopyDart = int Function(int, int);
final LZCopy = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<LZCopyNative, LZCopyDart>('LZCopy');
// hfSource : INT -> Int32
// hfDest : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LZCopy(
  hfSource: Integer;   // INT
  hfDest: Integer   // INT
): Integer; stdcall;
  external 'KERNEL32.dll' name 'LZCopy';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "LZCopy"
  c_LZCopy :: Int32 -> Int32 -> IO Int32
-- hfSource : INT -> Int32
-- hfDest : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let lzcopy =
  foreign "LZCopy"
    (int32_t @-> int32_t @-> returning int32_t)
(* hfSource : INT -> int32_t *)
(* hfDest : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("LZCopy" lzcopy :convention :stdcall) :int32
  (hf-source :int32)   ; INT
  (hf-dest :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LZCopy = Win32::API::More->new('KERNEL32',
    'int LZCopy(int hfSource, int hfDest)');
# my $ret = $LZCopy->Call($hfSource, $hfDest);
# hfSource : INT -> int
# hfDest : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目