LZRead

関数

LZ圧縮ファイルから展開したデータを読み取る。

DLLKERNEL32.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

INT LZRead(
    INT hFile,
    LPSTR lpBuffer,
    INT cbRead
);

パラメーター

名前	型	方向	説明
hFile	INT	in	ファイルへのハンドル。
lpBuffer	LPSTR	out	ファイルから読み取ったバイトを受け取るバッファーへのポインター。このバッファーが cbRead より大きいことを確認してください。
cbRead	INT	in	読み取るバイト数。

戻り値の型: INT

公式ドキュメント

ファイルから指定されたバイト数(最大)を読み取り、バッファーにコピーします。

戻り値

関数が成功した場合、戻り値は読み取られたバイト数を示します。

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

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

戻り値コード	説明
LZERROR_BADINHANDLE	ソースファイルを識別するハンドルが無効です。ファイルを読み取れません。
LZERROR_BADOUTHANDLE	出力先ファイルを識別するハンドルが無効です。ファイルに書き込めません。
LZERROR_BADVALUE	入力パラメーターのいずれかが無効です。
LZERROR_GLOBALLOC	開いている圧縮ファイルの最大数を超えたか、ローカルメモリを割り当てられません。
LZERROR_GLOBLOCK	LZ ファイルハンドルをロックできません。
LZERROR_READ	ソースファイルの形式が無効です。
LZERROR_WRITE	出力ファイル用の空き領域が不足しています。

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

解説(Remarks)

ファイルを識別するハンドルは、 LZInit 関数または LZOpenFile 関数のいずれかを呼び出して取得する必要があります。

ファイルが圧縮されている場合、 LZRead はファイルの展開イメージに対して動作し、データのバイトを指定されたバッファーにコピーします。

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 LZRead(
    INT hFile,
    LPSTR lpBuffer,
    INT cbRead
);

[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern int LZRead(
    int hFile,   // INT
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpBuffer,   // LPSTR out
    int cbRead   // INT
);

<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function LZRead(
    hFile As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPStr)> lpBuffer As System.Text.StringBuilder,   ' LPSTR out
    cbRead As Integer   ' INT
) As Integer
End Function

' hFile : INT
' lpBuffer : LPSTR out
' cbRead : INT
Declare PtrSafe Function LZRead Lib "kernel32" ( _
    ByVal hFile As Long, _
    ByVal lpBuffer As String, _
    ByVal cbRead As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

LZRead = ctypes.windll.kernel32.LZRead
LZRead.restype = ctypes.c_int
LZRead.argtypes = [
    ctypes.c_int,  # hFile : INT
    wintypes.LPSTR,  # lpBuffer : LPSTR out
    ctypes.c_int,  # cbRead : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
LZRead = Fiddle::Function.new(
  lib['LZRead'],
  [
    Fiddle::TYPE_INT,  # hFile : INT
    Fiddle::TYPE_VOIDP,  # lpBuffer : LPSTR out
    Fiddle::TYPE_INT,  # cbRead : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn LZRead(
        hFile: i32,  // INT
        lpBuffer: *mut u8,  // LPSTR out
        cbRead: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll")]
public static extern int LZRead(int hFile, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpBuffer, int cbRead);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_LZRead' -Namespace Win32 -PassThru
# $api::LZRead(hFile, lpBuffer, cbRead)

#uselib "KERNEL32.dll"
#func global LZRead "LZRead" sptr, sptr, sptr
; LZRead hFile, varptr(lpBuffer), cbRead   ; 戻り値は stat
; hFile : INT -> "sptr"
; lpBuffer : LPSTR out -> "sptr"
; cbRead : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global LZRead "LZRead" int, var, int
; res = LZRead(hFile, lpBuffer, cbRead)
; hFile : INT -> "int"
; lpBuffer : LPSTR out -> "var"
; cbRead : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global LZRead "LZRead" int, sptr, int
; res = LZRead(hFile, varptr(lpBuffer), cbRead)
; hFile : INT -> "int"
; lpBuffer : LPSTR out -> "sptr"
; cbRead : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。