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

LZInit

関数
LZ展開用にソースファイルを初期化する。
DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

INT LZInit(
    INT hfSource
);

パラメーター

名前方向説明
hfSourceINTinファイルへのハンドル。

戻り値の型: INT

公式ドキュメント

ファイルを展開するために必要な内部データ構造のメモリを割り当て、それらを作成して初期化します。

戻り値

関数が成功した場合、戻り値は新しい LZ ファイルハンドルです。

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

以下は、 LZInit が失敗時に返す可能性のあるエラーコードの一覧です。

戻りコード 説明
LZERROR_BADINHANDLE
ソースファイルを識別するハンドルが無効です。ファイルを読み取ることができません。
LZERROR_GLOBALLOC
開いている圧縮ファイルの最大数を超えたか、ローカルメモリを割り当てることができません。
LZERROR_GLOBLOCK
LZ ファイルハンドルをロックできません。
LZERROR_UNKNOWNALG
ファイルが認識できない圧縮アルゴリズムで圧縮されています。

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

解説(Remarks)

任意の時点で開くことができる圧縮ファイルは最大 16 個です。同様に、任意の時点で開くことができる非圧縮ファイルも最大 16 個です。アプリケーションは、ファイルの使用が終わったら LZInit が返したハンドルを確実に閉じるよう注意する必要があります。そうしないと、アプリケーションが意図せず 16 ファイルの上限に達する可能性があります。

この関数が返すハンドルは Lz32.dll の関数とのみ互換性があります。他のファイル操作には使用しないでください。

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

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 Transparent Failover (TFO) はい
SMB 3.0 with Scale-out File Shares (SO) はい
Cluster Shared Volume File System (CsvFS) はい
Resilient File System (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 LZInit(
    INT hfSource
);
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern int LZInit(
    int hfSource   // INT
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function LZInit(
    hfSource As Integer   ' INT
) As Integer
End Function
' hfSource : INT
Declare PtrSafe Function LZInit Lib "kernel32" ( _
    ByVal hfSource As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procLZInit = kernel32.NewProc("LZInit")
)

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

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

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

let lzinit =
  foreign "LZInit"
    (int32_t @-> returning int32_t)
(* hfSource : 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 ("LZInit" lzinit :convention :stdcall) :int32
  (hf-source :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LZInit = Win32::API::More->new('KERNEL32',
    'int LZInit(int hfSource)');
# my $ret = $LZInit->Call($hfSource);
# hfSource : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。