ホーム › Storage.FileSystem › GetCompressedFileSizeTransactedW

GetCompressedFileSizeTransactedW

関数

トランザクション内で圧縮ファイルの実サイズを取得する(Unicode版)。

DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

DWORD GetCompressedFileSizeTransactedW(
    LPCWSTR lpFileName,
    DWORD* lpFileSizeHigh,   // optional
    HANDLE hTransaction
);

パラメーター

名前	型	方向	説明
lpFileName	LPCWSTR	in	ファイルの名前。パイプや通信デバイスなど、シークできないデバイス上のファイル名は指定しないでください。そのようなファイルのサイズには意味がありません。ファイルはローカルコンピューター上に存在する必要があります。そうでない場合、関数は失敗し、最終エラーコードは ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE に設定されます。
lpFileSizeHigh	DWORD*	outoptional	圧縮ファイルサイズの上位 DWORD を受け取る変数へのポインター。関数の戻り値は圧縮ファイルサイズの下位 DWORD です。圧縮ファイルサイズの上位 DWORD が不要な場合、このパラメーターは NULL にできます。サイズが 4 ギガバイト未満のファイルでは上位 DWORD は不要です。
hTransaction	HANDLE	in	トランザクションへのハンドル。このハンドルは CreateTransaction 関数によって返されます。

名前

型

方向

説明

lpFileName

LPCWSTR

ファイルの名前。

パイプや通信デバイスなど、シークできないデバイス上のファイル名は指定しないでください。そのようなファイルのサイズには意味がありません。

ファイルはローカルコンピューター上に存在する必要があります。そうでない場合、関数は失敗し、最終エラーコードは ERROR_TRANSACTIONS_UNSUPPORTED_REMOTE に設定されます。

lpFileSizeHigh

DWORD*

outoptional

圧縮ファイルサイズの上位 DWORD を受け取る変数へのポインター。関数の戻り値は圧縮ファイルサイズの下位 DWORD です。

圧縮ファイルサイズの上位 DWORD が不要な場合、このパラメーターは NULL にできます。サイズが 4 ギガバイト未満のファイルでは上位 DWORD は不要です。

hTransaction

HANDLE

トランザクションへのハンドル。このハンドルは CreateTransaction 関数によって返されます。

戻り値の型: DWORD

公式ドキュメント

指定したファイルの格納に実際に使用されているディスク領域のバイト数を、トランザクション操作として取得します。(Unicode)

戻り値

関数が成功した場合、戻り値は指定したファイルの格納に実際に使用されているディスク領域のバイト数の下位 DWORD です。また、lpFileSizeHigh が非 NULL の場合、関数はその実際の値の上位 DWORD を、そのパラメーターが指す DWORD に格納します。これは、圧縮ファイルの場合は圧縮ファイルサイズ、非圧縮ファイルの場合は実際のファイルサイズです。

関数が失敗し、lpFileSizeHigh が NULL の場合、戻り値は INVALID_FILE_SIZE です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

戻り値が INVALID_FILE_SIZE で、かつ lpFileSizeHigh が非 NULL の場合、アプリケーションは GetLastError を呼び出して、関数が成功したか(値が NO_ERROR)失敗したか(値が NO_ERROR 以外)を判別する必要があります。

解説(Remarks)

アプリケーションは、 GetVolumeInformation を呼び出し、その関数の lpFileSystemFlags パラメーターが指す DWORD 値内の FS_VOL_IS_COMPRESSED フラグの状態を確認することで、ボリュームが圧縮されているかどうかを判別できます。

ファイルが圧縮またはスパースファイルをサポートするボリューム上に存在しない場合、またはファイルが圧縮ファイルやスパースファイルでない場合、取得される値は実際のファイルサイズであり、 GetFileSize の呼び出しによって返される値と同じです。

シンボリックリンク: パスがシンボリックリンクを指している場合、関数はターゲットのファイルサイズを返します。

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

テクノロジ	サポート
Server Message Block (SMB) 3.0 プロトコル	いいえ
SMB 3.0 透過的フェールオーバー (TFO)	いいえ
SMB 3.0 スケールアウトファイル共有 (SO)	いいえ
クラスター共有ボリュームファイルシステム (CsvFS)	いいえ
回復性ファイルシステム (ReFS)	いいえ

SMB 3.0 は TxF をサポートしていません。

メモ

winbase.h ヘッダーは GetCompressedFileSizeTransacted を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

DWORD GetCompressedFileSizeTransactedW(
    LPCWSTR lpFileName,
    DWORD* lpFileSizeHigh,   // optional
    HANDLE hTransaction
);

[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern uint GetCompressedFileSizeTransactedW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpFileName,   // LPCWSTR
    IntPtr lpFileSizeHigh,   // DWORD* optional, out
    IntPtr hTransaction   // HANDLE
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetCompressedFileSizeTransactedW(
    <MarshalAs(UnmanagedType.LPWStr)> lpFileName As String,   ' LPCWSTR
    lpFileSizeHigh As IntPtr,   ' DWORD* optional, out
    hTransaction As IntPtr   ' HANDLE
) As UInteger
End Function

' lpFileName : LPCWSTR
' lpFileSizeHigh : DWORD* optional, out
' hTransaction : HANDLE
Declare PtrSafe Function GetCompressedFileSizeTransactedW Lib "kernel32" ( _
    ByVal lpFileName As LongPtr, _
    ByVal lpFileSizeHigh As LongPtr, _
    ByVal hTransaction As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetCompressedFileSizeTransactedW = ctypes.windll.kernel32.GetCompressedFileSizeTransactedW
GetCompressedFileSizeTransactedW.restype = wintypes.DWORD
GetCompressedFileSizeTransactedW.argtypes = [
    wintypes.LPCWSTR,  # lpFileName : LPCWSTR
    ctypes.POINTER(wintypes.DWORD),  # lpFileSizeHigh : DWORD* optional, out
    wintypes.HANDLE,  # hTransaction : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetCompressedFileSizeTransactedW = Fiddle::Function.new(
  lib['GetCompressedFileSizeTransactedW'],
  [
    Fiddle::TYPE_VOIDP,  # lpFileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpFileSizeHigh : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # hTransaction : HANDLE
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn GetCompressedFileSizeTransactedW(
        lpFileName: *const u16,  // LPCWSTR
        lpFileSizeHigh: *mut u32,  // DWORD* optional, out
        hTransaction: *mut core::ffi::c_void  // HANDLE
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern uint GetCompressedFileSizeTransactedW([MarshalAs(UnmanagedType.LPWStr)] string lpFileName, IntPtr lpFileSizeHigh, IntPtr hTransaction);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetCompressedFileSizeTransactedW' -Namespace Win32 -PassThru
# $api::GetCompressedFileSizeTransactedW(lpFileName, lpFileSizeHigh, hTransaction)

#uselib "KERNEL32.dll"
#func global GetCompressedFileSizeTransactedW "GetCompressedFileSizeTransactedW" wptr, wptr, wptr
; GetCompressedFileSizeTransactedW lpFileName, varptr(lpFileSizeHigh), hTransaction   ; 戻り値は stat
; lpFileName : LPCWSTR -> "wptr"
; lpFileSizeHigh : DWORD* optional, out -> "wptr"
; hTransaction : HANDLE -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global GetCompressedFileSizeTransactedW "GetCompressedFileSizeTransactedW" wstr, var, sptr
; res = GetCompressedFileSizeTransactedW(lpFileName, lpFileSizeHigh, hTransaction)
; lpFileName : LPCWSTR -> "wstr"
; lpFileSizeHigh : DWORD* optional, out -> "var"
; hTransaction : HANDLE -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global GetCompressedFileSizeTransactedW "GetCompressedFileSizeTransactedW" wstr, sptr, sptr
; res = GetCompressedFileSizeTransactedW(lpFileName, varptr(lpFileSizeHigh), hTransaction)
; lpFileName : LPCWSTR -> "wstr"
; lpFileSizeHigh : DWORD* optional, out -> "sptr"
; hTransaction : HANDLE -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。