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

StrFormatByteSizeEx

関数
バイト数を読みやすい単位の文字列に整形する。
DLLSHLWAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

HRESULT StrFormatByteSizeEx(
    ULONGLONG ull,
    SFBS_FLAGS flags,
    LPWSTR pszBuf,
    DWORD cchBuf
);

パラメーター

名前方向説明
ullULONGLONGin変換対象の数値。
flagsSFBS_FLAGSin表示されない桁を丸めるか切り捨てるかを指定する SFBS_FLAGS 列挙値のいずれか。この値を NULL にすることはできません。
pszBufLPWSTRout変換後の文字列を受け取るバッファーへのポインター。
cchBufDWORDinpszBuf が指すバッファーのサイズ(文字単位)。

戻り値の型: HRESULT

公式ドキュメント

数値を、そのサイズに応じてバイト、キロバイト、メガバイト、またはギガバイトで表す文字列に変換します。

戻り値

型: HRESULT

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

次の表は、渡されたフラグに応じてこの関数が数値をテキスト文字列にどのように変換するかを示しています。

数値 フラグ テキスト文字列
2147483647 SFBS_FLAGS_ROUND_TO_NEAREST_DISPLAYED_DIGIT 2.00 GB
2147483647 SFBS_FLAGS_TRUNCATE_UNDISPLAYED_DECIMAL_DIGITS 1.99 GB

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

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

各言語での呼び出し定義

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

HRESULT StrFormatByteSizeEx(
    ULONGLONG ull,
    SFBS_FLAGS flags,
    LPWSTR pszBuf,
    DWORD cchBuf
);
[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern int StrFormatByteSizeEx(
    ulong ull,   // ULONGLONG
    int flags,   // SFBS_FLAGS
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszBuf,   // LPWSTR out
    uint cchBuf   // DWORD
);
<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function StrFormatByteSizeEx(
    ull As ULong,   ' ULONGLONG
    flags As Integer,   ' SFBS_FLAGS
    <MarshalAs(UnmanagedType.LPWStr)> pszBuf As System.Text.StringBuilder,   ' LPWSTR out
    cchBuf As UInteger   ' DWORD
) As Integer
End Function
' ull : ULONGLONG
' flags : SFBS_FLAGS
' pszBuf : LPWSTR out
' cchBuf : DWORD
Declare PtrSafe Function StrFormatByteSizeEx Lib "shlwapi" ( _
    ByVal ull As LongLong, _
    ByVal flags As Long, _
    ByVal pszBuf As LongPtr, _
    ByVal cchBuf As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

StrFormatByteSizeEx = ctypes.windll.shlwapi.StrFormatByteSizeEx
StrFormatByteSizeEx.restype = ctypes.c_int
StrFormatByteSizeEx.argtypes = [
    ctypes.c_ulonglong,  # ull : ULONGLONG
    ctypes.c_int,  # flags : SFBS_FLAGS
    wintypes.LPWSTR,  # pszBuf : LPWSTR out
    wintypes.DWORD,  # cchBuf : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
	procStrFormatByteSizeEx = shlwapi.NewProc("StrFormatByteSizeEx")
)

// ull (ULONGLONG), flags (SFBS_FLAGS), pszBuf (LPWSTR out), cchBuf (DWORD)
r1, _, err := procStrFormatByteSizeEx.Call(
	uintptr(ull),
	uintptr(flags),
	uintptr(pszBuf),
	uintptr(cchBuf),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function StrFormatByteSizeEx(
  ull: UInt64;   // ULONGLONG
  flags: Integer;   // SFBS_FLAGS
  pszBuf: PWideChar;   // LPWSTR out
  cchBuf: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'StrFormatByteSizeEx';
result := DllCall("SHLWAPI\StrFormatByteSizeEx"
    , "Int64", ull   ; ULONGLONG
    , "Int", flags   ; SFBS_FLAGS
    , "Ptr", pszBuf   ; LPWSTR out
    , "UInt", cchBuf   ; DWORD
    , "Int")   ; return: HRESULT
●StrFormatByteSizeEx(ull, flags, pszBuf, cchBuf) = DLL("SHLWAPI.dll", "int StrFormatByteSizeEx(qword, int, char*, dword)")
# 呼び出し: StrFormatByteSizeEx(ull, flags, pszBuf, cchBuf)
# ull : ULONGLONG -> "qword"
# flags : SFBS_FLAGS -> "int"
# pszBuf : LPWSTR out -> "char*"
# cchBuf : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "shlwapi" fn StrFormatByteSizeEx(
    ull: u64, // ULONGLONG
    flags: i32, // SFBS_FLAGS
    pszBuf: [*c]u16, // LPWSTR out
    cchBuf: u32 // DWORD
) callconv(std.os.windows.WINAPI) i32;
proc StrFormatByteSizeEx(
    ull: uint64,  # ULONGLONG
    flags: int32,  # SFBS_FLAGS
    pszBuf: ptr uint16,  # LPWSTR out
    cchBuf: uint32  # DWORD
): int32 {.importc: "StrFormatByteSizeEx", stdcall, dynlib: "SHLWAPI.dll".}
pragma(lib, "shlwapi");
extern(Windows)
int StrFormatByteSizeEx(
    ulong ull,   // ULONGLONG
    int flags,   // SFBS_FLAGS
    wchar* pszBuf,   // LPWSTR out
    uint cchBuf   // DWORD
);
ccall((:StrFormatByteSizeEx, "SHLWAPI.dll"), stdcall, Int32,
      (UInt64, Int32, Ptr{UInt16}, UInt32),
      ull, flags, pszBuf, cchBuf)
# ull : ULONGLONG -> UInt64
# flags : SFBS_FLAGS -> Int32
# pszBuf : LPWSTR out -> Ptr{UInt16}
# cchBuf : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t StrFormatByteSizeEx(
    uint64_t ull,
    int32_t flags,
    uint16_t* pszBuf,
    uint32_t cchBuf);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.StrFormatByteSizeEx(ull, flags, pszBuf, cchBuf)
-- ull : ULONGLONG
-- flags : SFBS_FLAGS
-- pszBuf : LPWSTR out
-- cchBuf : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const StrFormatByteSizeEx = lib.func('__stdcall', 'StrFormatByteSizeEx', 'int32_t', ['uint64_t', 'int32_t', 'uint16_t *', 'uint32_t']);
// StrFormatByteSizeEx(ull, flags, pszBuf, cchBuf)
// ull : ULONGLONG -> 'uint64_t'
// flags : SFBS_FLAGS -> 'int32_t'
// pszBuf : LPWSTR out -> 'uint16_t *'
// cchBuf : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SHLWAPI.dll", {
  StrFormatByteSizeEx: { parameters: ["u64", "i32", "buffer", "u32"], result: "i32" },
});
// lib.symbols.StrFormatByteSizeEx(ull, flags, pszBuf, cchBuf)
// ull : ULONGLONG -> "u64"
// flags : SFBS_FLAGS -> "i32"
// pszBuf : LPWSTR out -> "buffer"
// cchBuf : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t StrFormatByteSizeEx(
    uint64_t ull,
    int32_t flags,
    uint16_t* pszBuf,
    uint32_t cchBuf);
C, "SHLWAPI.dll");
// $ffi->StrFormatByteSizeEx(ull, flags, pszBuf, cchBuf);
// ull : ULONGLONG
// flags : SFBS_FLAGS
// 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);
    int StrFormatByteSizeEx(
        long ull,   // ULONGLONG
        int flags,   // SFBS_FLAGS
        char[] pszBuf,   // LPWSTR out
        int cchBuf   // DWORD
    );
}
@[Link("shlwapi")]
lib LibSHLWAPI
  fun StrFormatByteSizeEx = StrFormatByteSizeEx(
    ull : UInt64,   # ULONGLONG
    flags : Int32,   # SFBS_FLAGS
    pszBuf : UInt16*,   # LPWSTR out
    cchBuf : UInt32   # DWORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef StrFormatByteSizeExNative = Int32 Function(Uint64, Int32, Pointer<Utf16>, Uint32);
typedef StrFormatByteSizeExDart = int Function(int, int, Pointer<Utf16>, int);
final StrFormatByteSizeEx = DynamicLibrary.open('SHLWAPI.dll')
    .lookupFunction<StrFormatByteSizeExNative, StrFormatByteSizeExDart>('StrFormatByteSizeEx');
// ull : ULONGLONG -> Uint64
// flags : SFBS_FLAGS -> Int32
// pszBuf : LPWSTR out -> Pointer<Utf16>
// cchBuf : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function StrFormatByteSizeEx(
  ull: UInt64;   // ULONGLONG
  flags: Integer;   // SFBS_FLAGS
  pszBuf: PWideChar;   // LPWSTR out
  cchBuf: DWORD   // DWORD
): Integer; stdcall;
  external 'SHLWAPI.dll' name 'StrFormatByteSizeEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "StrFormatByteSizeEx"
  c_StrFormatByteSizeEx :: Word64 -> Int32 -> CWString -> Word32 -> IO Int32
-- ull : ULONGLONG -> Word64
-- flags : SFBS_FLAGS -> Int32
-- pszBuf : LPWSTR out -> CWString
-- cchBuf : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let strformatbytesizeex =
  foreign "StrFormatByteSizeEx"
    (uint64_t @-> int32_t @-> (ptr uint16_t) @-> uint32_t @-> returning int32_t)
(* ull : ULONGLONG -> uint64_t *)
(* flags : SFBS_FLAGS -> int32_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 ("StrFormatByteSizeEx" str-format-byte-size-ex :convention :stdcall) :int32
  (ull :uint64)   ; ULONGLONG
  (flags :int32)   ; SFBS_FLAGS
  (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 $StrFormatByteSizeEx = Win32::API::More->new('SHLWAPI',
    'int StrFormatByteSizeEx(UINT64 ull, int flags, LPWSTR pszBuf, DWORD cchBuf)');
# my $ret = $StrFormatByteSizeEx->Call($ull, $flags, $pszBuf, $cchBuf);
# ull : ULONGLONG -> UINT64
# flags : SFBS_FLAGS -> int
# pszBuf : LPWSTR out -> LPWSTR
# cchBuf : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
公式の関連項目
使用する型