Win32 API 日本語リファレンス
ホームUI.Shell › StrFormatByteSizeW

StrFormatByteSizeW

関数
64ビットのバイト数を見やすい単位文字列に整形する。
DLLSHLWAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

LPWSTR StrFormatByteSizeW(
    LONGLONG qdw,
    LPWSTR pszBuf,
    DWORD cchBuf
);

パラメーター

名前方向説明
qdwLONGLONGin変換する数値。
pszBufLPWSTRoutこの関数が正常に返ったときに、変換後の数値を受け取るバッファーへのポインター。
cchBufDWORDinpszBuf が指すバッファーのサイズ(文字数単位)。

戻り値の型: LPWSTR

公式ドキュメント

数値を、そのサイズに応じてバイト、キロバイト、メガバイト、またはギガバイトで表現したサイズ値を表す文字列に変換します。1 つのパラメーターの型が StrFormatByteSizeA とは異なります。

戻り値

型: PWSTR

変換後の文字列へのポインターを返します。変換に失敗した場合は NULL を返します。

解説(Remarks)

この関数の最初のパラメーターは、ANSI 版と Unicode 版とで型が異なります。数値が DWORD である場合は、両方のケースに対してテキストマクロを使う StrFormatByteSize を使用できます。Unicode の場合、コンパイラーが数値を LONGLONG にキャストします。数値が LONGLONG である場合は、明示的に StrFormatByteSizeW を使用してください。

Windows 10 では、サイズは 2 進ではなく 10 進で報告されます。たとえば、1 KB は 1024 バイトではなく 1000 バイトです。

次の表は、この関数が数値をテキスト文字列にどのように変換するかを示しています。

数値 テキスト文字列
532 532 bytes
1340 1.30 KB
23506 22.9 KB
2400016 2.28 MB
2400000000 2.23 GB
メモ

shlwapi.h ヘッダーは、UNICODE プリプロセッサー定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして StrFormatByteSize を定義しています。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での呼び出し定義

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

LPWSTR StrFormatByteSizeW(
    LONGLONG qdw,
    LPWSTR pszBuf,
    DWORD cchBuf
);
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern IntPtr StrFormatByteSizeW(
    long qdw,   // LONGLONG
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszBuf,   // LPWSTR out
    uint cchBuf   // DWORD
);
<DllImport("SHLWAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function StrFormatByteSizeW(
    qdw As Long,   ' LONGLONG
    <MarshalAs(UnmanagedType.LPWStr)> pszBuf As System.Text.StringBuilder,   ' LPWSTR out
    cchBuf As UInteger   ' DWORD
) As IntPtr
End Function
' qdw : LONGLONG
' pszBuf : LPWSTR out
' cchBuf : DWORD
Declare PtrSafe Function StrFormatByteSizeW Lib "shlwapi" ( _
    ByVal qdw As LongLong, _
    ByVal pszBuf As LongPtr, _
    ByVal cchBuf As Long) As LongPtr
' 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

StrFormatByteSizeW = ctypes.windll.shlwapi.StrFormatByteSizeW
StrFormatByteSizeW.restype = wintypes.LPWSTR
StrFormatByteSizeW.argtypes = [
    ctypes.c_longlong,  # qdw : LONGLONG
    wintypes.LPWSTR,  # pszBuf : LPWSTR out
    wintypes.DWORD,  # cchBuf : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SHLWAPI.dll')
StrFormatByteSizeW = Fiddle::Function.new(
  lib['StrFormatByteSizeW'],
  [
    Fiddle::TYPE_LONG_LONG,  # qdw : LONGLONG
    Fiddle::TYPE_VOIDP,  # pszBuf : LPWSTR out
    -Fiddle::TYPE_INT,  # cchBuf : DWORD
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "shlwapi")]
extern "system" {
    fn StrFormatByteSizeW(
        qdw: i64,  // LONGLONG
        pszBuf: *mut u16,  // LPWSTR out
        cchBuf: u32  // DWORD
    ) -> *mut u16;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Unicode)]
public static extern IntPtr StrFormatByteSizeW(long qdw, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszBuf, uint cchBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_StrFormatByteSizeW' -Namespace Win32 -PassThru
# $api::StrFormatByteSizeW(qdw, pszBuf, cchBuf)
#uselib "SHLWAPI.dll"
#func global StrFormatByteSizeW "StrFormatByteSizeW" wptr, wptr, wptr
; StrFormatByteSizeW qdw, varptr(pszBuf), cchBuf   ; 戻り値は stat
; qdw : LONGLONG -> "wptr"
; pszBuf : LPWSTR out -> "wptr"
; cchBuf : DWORD -> "wptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SHLWAPI.dll"
#cfunc global StrFormatByteSizeW "StrFormatByteSizeW" int64, var, int
; res = StrFormatByteSizeW(qdw, pszBuf, cchBuf)
; qdw : LONGLONG -> "int64"
; pszBuf : LPWSTR out -> "var"
; cchBuf : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数:
; LPWSTR StrFormatByteSizeW(LONGLONG qdw, LPWSTR pszBuf, DWORD cchBuf)
#uselib "SHLWAPI.dll"
#cfunc global StrFormatByteSizeW "StrFormatByteSizeW" int64, var, int
; res = StrFormatByteSizeW(qdw, pszBuf, cchBuf)
; qdw : LONGLONG -> "int64"
; pszBuf : LPWSTR out -> "var"
; cchBuf : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procStrFormatByteSizeW = shlwapi.NewProc("StrFormatByteSizeW")
)

// qdw (LONGLONG), pszBuf (LPWSTR out), cchBuf (DWORD)
r1, _, err := procStrFormatByteSizeW.Call(
	uintptr(qdw),
	uintptr(pszBuf),
	uintptr(cchBuf),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // LPWSTR
function StrFormatByteSizeW(
  qdw: Int64;   // LONGLONG
  pszBuf: PWideChar;   // LPWSTR out
  cchBuf: DWORD   // DWORD
): PWideChar; stdcall;
  external 'SHLWAPI.dll' name 'StrFormatByteSizeW';
result := DllCall("SHLWAPI\StrFormatByteSizeW"
    , "Int64", qdw   ; LONGLONG
    , "Ptr", pszBuf   ; LPWSTR out
    , "UInt", cchBuf   ; DWORD
    , "Ptr")   ; return: LPWSTR
●StrFormatByteSizeW(qdw, pszBuf, cchBuf) = DLL("SHLWAPI.dll", "char* StrFormatByteSizeW(int64, char*, dword)")
# 呼び出し: StrFormatByteSizeW(qdw, pszBuf, cchBuf)
# qdw : LONGLONG -> "int64"
# pszBuf : LPWSTR out -> "char*"
# cchBuf : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "shlwapi" fn StrFormatByteSizeW(
    qdw: i64, // LONGLONG
    pszBuf: [*c]u16, // LPWSTR out
    cchBuf: u32 // DWORD
) callconv(std.os.windows.WINAPI) [*c]const u16;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc StrFormatByteSizeW(
    qdw: int64,  # LONGLONG
    pszBuf: ptr uint16,  # LPWSTR out
    cchBuf: uint32  # DWORD
): WideCString {.importc: "StrFormatByteSizeW", stdcall, dynlib: "SHLWAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "shlwapi");
extern(Windows)
const(wchar)* StrFormatByteSizeW(
    long qdw,   // LONGLONG
    wchar* pszBuf,   // LPWSTR out
    uint cchBuf   // DWORD
);
ccall((:StrFormatByteSizeW, "SHLWAPI.dll"), stdcall, Cwstring,
      (Int64, Ptr{UInt16}, UInt32),
      qdw, pszBuf, cchBuf)
# qdw : LONGLONG -> Int64
# pszBuf : LPWSTR out -> Ptr{UInt16}
# cchBuf : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
const uint16_t* StrFormatByteSizeW(
    int64_t qdw,
    uint16_t* pszBuf,
    uint32_t cchBuf);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.StrFormatByteSizeW(qdw, pszBuf, cchBuf)
-- qdw : LONGLONG
-- pszBuf : LPWSTR out
-- cchBuf : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const StrFormatByteSizeW = lib.func('__stdcall', 'StrFormatByteSizeW', 'void *', ['int64_t', 'uint16_t *', 'uint32_t']);
// StrFormatByteSizeW(qdw, pszBuf, cchBuf)
// qdw : LONGLONG -> 'int64_t'
// pszBuf : LPWSTR out -> 'uint16_t *'
// cchBuf : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  StrFormatByteSizeW: { parameters: ["i64", "buffer", "u32"], result: "pointer" },
});
// lib.symbols.StrFormatByteSizeW(qdw, pszBuf, cchBuf)
// qdw : LONGLONG -> "i64"
// pszBuf : LPWSTR out -> "buffer"
// cchBuf : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
const uint16_t* StrFormatByteSizeW(
    int64_t qdw,
    uint16_t* pszBuf,
    uint32_t cchBuf);
C, "SHLWAPI.dll");
// $ffi->StrFormatByteSizeW(qdw, pszBuf, cchBuf);
// qdw : LONGLONG
// pszBuf : LPWSTR out
// cchBuf : DWORD
// 構造体/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 Shlwapi extends StdCallLibrary {
    Shlwapi INSTANCE = Native.load("shlwapi", Shlwapi.class, W32APIOptions.UNICODE_OPTIONS);
    Pointer StrFormatByteSizeW(
        long qdw,   // LONGLONG
        char[] pszBuf,   // LPWSTR out
        int cchBuf   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("shlwapi")]
lib LibSHLWAPI
  fun StrFormatByteSizeW = StrFormatByteSizeW(
    qdw : Int64,   # LONGLONG
    pszBuf : UInt16*,   # LPWSTR out
    cchBuf : UInt32   # DWORD
  ) : UInt16*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef StrFormatByteSizeWNative = Pointer<Utf16> Function(Int64, Pointer<Utf16>, Uint32);
typedef StrFormatByteSizeWDart = Pointer<Utf16> Function(int, Pointer<Utf16>, int);
final StrFormatByteSizeW = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<StrFormatByteSizeWNative, StrFormatByteSizeWDart>('StrFormatByteSizeW');
// qdw : LONGLONG -> Int64
// pszBuf : LPWSTR out -> Pointer<Utf16>
// cchBuf : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function StrFormatByteSizeW(
  qdw: Int64;   // LONGLONG
  pszBuf: PWideChar;   // LPWSTR out
  cchBuf: DWORD   // DWORD
): PWideChar; stdcall;
  external 'SHLWAPI.dll' name 'StrFormatByteSizeW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "StrFormatByteSizeW"
  c_StrFormatByteSizeW :: Int64 -> CWString -> Word32 -> IO CWString
-- qdw : LONGLONG -> Int64
-- pszBuf : LPWSTR out -> CWString
-- cchBuf : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let strformatbytesizew =
  foreign "StrFormatByteSizeW"
    (int64_t @-> (ptr uint16_t) @-> uint32_t @-> returning (ptr uint16_t))
(* qdw : LONGLONG -> int64_t *)
(* pszBuf : LPWSTR out -> (ptr uint16_t) *)
(* cchBuf : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library shlwapi (t "SHLWAPI.dll"))
(cffi:use-foreign-library shlwapi)

(cffi:defcfun ("StrFormatByteSizeW" str-format-byte-size-w :convention :stdcall) (:string :encoding :utf-16le)
  (qdw :int64)   ; LONGLONG
  (psz-buf :pointer)   ; LPWSTR out
  (cch-buf :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $StrFormatByteSizeW = Win32::API::More->new('SHLWAPI',
    'LPWSTR StrFormatByteSizeW(INT64 qdw, LPWSTR pszBuf, DWORD cchBuf)');
# my $ret = $StrFormatByteSizeW->Call($qdw, $pszBuf, $cchBuf);
# qdw : LONGLONG -> INT64
# pszBuf : LPWSTR out -> LPWSTR
# cchBuf : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
公式の関連項目