StrFormatByteSizeA
関数バイト数をKBやMBなど見やすい文字列に整形する。
シグネチャ
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
LPSTR StrFormatByteSizeA(
DWORD dw,
LPSTR pszBuf,
DWORD cchBuf
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| dw | DWORD | in | 変換する数値。 |
| pszBuf | LPSTR | out | 変換後の文字列を受け取るバッファーへのポインター。 |
| cchBuf | DWORD | in | pszBuf が指すバッファーのサイズ(文字数)。 |
戻り値の型: LPSTR
公式ドキュメント
数値を、そのサイズに応じてバイト、キロバイト、メガバイト、またはギガバイトのサイズ値として表現する文字列に変換します。1 つのパラメーターの型が StrFormatByteSizeW と異なります。
戻り値
型: PSTR
変換後の文字列へのポインターを返します。変換に失敗した場合は NULL を返します。
解説(Remarks)
この関数の第 1 パラメーターは、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 ヘッダーは、StrFormatByteSize を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不一致が生じる可能性があります。詳細については、関数プロトタイプの規約を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// SHLWAPI.dll (ANSI / -A)
#include <windows.h>
LPSTR StrFormatByteSizeA(
DWORD dw,
LPSTR pszBuf,
DWORD cchBuf
);[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern IntPtr StrFormatByteSizeA(
uint dw, // DWORD
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszBuf, // LPSTR out
uint cchBuf // DWORD
);<DllImport("SHLWAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function StrFormatByteSizeA(
dw As UInteger, ' DWORD
<MarshalAs(UnmanagedType.LPStr)> pszBuf As System.Text.StringBuilder, ' LPSTR out
cchBuf As UInteger ' DWORD
) As IntPtr
End Function' dw : DWORD
' pszBuf : LPSTR out
' cchBuf : DWORD
Declare PtrSafe Function StrFormatByteSizeA Lib "shlwapi" ( _
ByVal dw As Long, _
ByVal pszBuf As String, _
ByVal cchBuf As Long) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
StrFormatByteSizeA = ctypes.windll.shlwapi.StrFormatByteSizeA
StrFormatByteSizeA.restype = wintypes.LPSTR
StrFormatByteSizeA.argtypes = [
wintypes.DWORD, # dw : DWORD
wintypes.LPSTR, # pszBuf : LPSTR out
wintypes.DWORD, # cchBuf : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
StrFormatByteSizeA = Fiddle::Function.new(
lib['StrFormatByteSizeA'],
[
-Fiddle::TYPE_INT, # dw : DWORD
Fiddle::TYPE_VOIDP, # pszBuf : LPSTR out
-Fiddle::TYPE_INT, # cchBuf : DWORD
],
Fiddle::TYPE_VOIDP)#[link(name = "shlwapi")]
extern "system" {
fn StrFormatByteSizeA(
dw: u32, // DWORD
pszBuf: *mut u8, // LPSTR out
cchBuf: u32 // DWORD
) -> *mut u8;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHLWAPI.dll", CharSet = CharSet.Ansi)]
public static extern IntPtr StrFormatByteSizeA(uint dw, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszBuf, uint cchBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_StrFormatByteSizeA' -Namespace Win32 -PassThru
# $api::StrFormatByteSizeA(dw, pszBuf, cchBuf)#uselib "SHLWAPI.dll"
#func global StrFormatByteSizeA "StrFormatByteSizeA" sptr, sptr, sptr
; StrFormatByteSizeA dw, varptr(pszBuf), cchBuf ; 戻り値は stat
; dw : DWORD -> "sptr"
; pszBuf : LPSTR out -> "sptr"
; cchBuf : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SHLWAPI.dll" #cfunc global StrFormatByteSizeA "StrFormatByteSizeA" int, var, int ; res = StrFormatByteSizeA(dw, pszBuf, cchBuf) ; dw : DWORD -> "int" ; pszBuf : LPSTR out -> "var" ; cchBuf : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SHLWAPI.dll" #cfunc global StrFormatByteSizeA "StrFormatByteSizeA" int, sptr, int ; res = StrFormatByteSizeA(dw, varptr(pszBuf), cchBuf) ; dw : DWORD -> "int" ; pszBuf : LPSTR out -> "sptr" ; cchBuf : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; LPSTR StrFormatByteSizeA(DWORD dw, LPSTR pszBuf, DWORD cchBuf) #uselib "SHLWAPI.dll" #cfunc global StrFormatByteSizeA "StrFormatByteSizeA" int, var, int ; res = StrFormatByteSizeA(dw, pszBuf, cchBuf) ; dw : DWORD -> "int" ; pszBuf : LPSTR out -> "var" ; cchBuf : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; LPSTR StrFormatByteSizeA(DWORD dw, LPSTR pszBuf, DWORD cchBuf) #uselib "SHLWAPI.dll" #cfunc global StrFormatByteSizeA "StrFormatByteSizeA" int, intptr, int ; res = StrFormatByteSizeA(dw, varptr(pszBuf), cchBuf) ; dw : DWORD -> "int" ; pszBuf : LPSTR out -> "intptr" ; cchBuf : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procStrFormatByteSizeA = shlwapi.NewProc("StrFormatByteSizeA")
)
// dw (DWORD), pszBuf (LPSTR out), cchBuf (DWORD)
r1, _, err := procStrFormatByteSizeA.Call(
uintptr(dw),
uintptr(pszBuf),
uintptr(cchBuf),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // LPSTRfunction StrFormatByteSizeA(
dw: DWORD; // DWORD
pszBuf: PAnsiChar; // LPSTR out
cchBuf: DWORD // DWORD
): PAnsiChar; stdcall;
external 'SHLWAPI.dll' name 'StrFormatByteSizeA';result := DllCall("SHLWAPI\StrFormatByteSizeA"
, "UInt", dw ; DWORD
, "Ptr", pszBuf ; LPSTR out
, "UInt", cchBuf ; DWORD
, "Ptr") ; return: LPSTR●StrFormatByteSizeA(dw, pszBuf, cchBuf) = DLL("SHLWAPI.dll", "char* StrFormatByteSizeA(dword, char*, dword)")
# 呼び出し: StrFormatByteSizeA(dw, pszBuf, cchBuf)
# dw : DWORD -> "dword"
# pszBuf : LPSTR out -> "char*"
# cchBuf : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn StrFormatByteSizeA(
dw: u32, // DWORD
pszBuf: [*c]u8, // LPSTR out
cchBuf: u32 // DWORD
) callconv(std.os.windows.WINAPI) [*c]const u8;proc StrFormatByteSizeA(
dw: uint32, # DWORD
pszBuf: ptr char, # LPSTR out
cchBuf: uint32 # DWORD
): cstring {.importc: "StrFormatByteSizeA", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
const(char)* StrFormatByteSizeA(
uint dw, // DWORD
char* pszBuf, // LPSTR out
uint cchBuf // DWORD
);ccall((:StrFormatByteSizeA, "SHLWAPI.dll"), stdcall, Cstring,
(UInt32, Ptr{UInt8}, UInt32),
dw, pszBuf, cchBuf)
# dw : DWORD -> UInt32
# pszBuf : LPSTR out -> Ptr{UInt8}
# cchBuf : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
const char* StrFormatByteSizeA(
uint32_t dw,
char* pszBuf,
uint32_t cchBuf);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.StrFormatByteSizeA(dw, pszBuf, cchBuf)
-- dw : DWORD
-- pszBuf : LPSTR out
-- cchBuf : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const StrFormatByteSizeA = lib.func('__stdcall', 'StrFormatByteSizeA', 'void *', ['uint32_t', 'char *', 'uint32_t']);
// StrFormatByteSizeA(dw, pszBuf, cchBuf)
// dw : DWORD -> 'uint32_t'
// pszBuf : LPSTR out -> 'char *'
// cchBuf : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
StrFormatByteSizeA: { parameters: ["u32", "buffer", "u32"], result: "pointer" },
});
// lib.symbols.StrFormatByteSizeA(dw, pszBuf, cchBuf)
// dw : DWORD -> "u32"
// pszBuf : LPSTR out -> "buffer"
// cchBuf : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
const char* StrFormatByteSizeA(
uint32_t dw,
char* pszBuf,
uint32_t cchBuf);
C, "SHLWAPI.dll");
// $ffi->StrFormatByteSizeA(dw, pszBuf, cchBuf);
// dw : DWORD
// pszBuf : LPSTR 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.ASCII_OPTIONS);
Pointer StrFormatByteSizeA(
int dw, // DWORD
byte[] pszBuf, // LPSTR out
int cchBuf // DWORD
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun StrFormatByteSizeA = StrFormatByteSizeA(
dw : UInt32, # DWORD
pszBuf : UInt8*, # LPSTR out
cchBuf : UInt32 # DWORD
) : UInt8*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef StrFormatByteSizeANative = Pointer<Utf8> Function(Uint32, Pointer<Utf8>, Uint32);
typedef StrFormatByteSizeADart = Pointer<Utf8> Function(int, Pointer<Utf8>, int);
final StrFormatByteSizeA = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<StrFormatByteSizeANative, StrFormatByteSizeADart>('StrFormatByteSizeA');
// dw : DWORD -> Uint32
// pszBuf : LPSTR out -> Pointer<Utf8>
// cchBuf : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function StrFormatByteSizeA(
dw: DWORD; // DWORD
pszBuf: PAnsiChar; // LPSTR out
cchBuf: DWORD // DWORD
): PAnsiChar; stdcall;
external 'SHLWAPI.dll' name 'StrFormatByteSizeA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "StrFormatByteSizeA"
c_StrFormatByteSizeA :: Word32 -> CString -> Word32 -> IO CString
-- dw : DWORD -> Word32
-- pszBuf : LPSTR out -> CString
-- cchBuf : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let strformatbytesizea =
foreign "StrFormatByteSizeA"
(uint32_t @-> string @-> uint32_t @-> returning string)
(* dw : DWORD -> uint32_t *)
(* pszBuf : LPSTR out -> string *)
(* 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 ("StrFormatByteSizeA" str-format-byte-size-a :convention :stdcall) :string
(dw :uint32) ; DWORD
(psz-buf :pointer) ; LPSTR out
(cch-buf :uint32)) ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $StrFormatByteSizeA = Win32::API::More->new('SHLWAPI',
'LPSTR StrFormatByteSizeA(DWORD dw, LPSTR pszBuf, DWORD cchBuf)');
# my $ret = $StrFormatByteSizeA->Call($dw, $pszBuf, $cchBuf);
# dw : DWORD -> DWORD
# pszBuf : LPSTR out -> LPSTR
# cchBuf : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f StrFormatByteSizeW (Unicode版) — 64ビットのバイト数を見やすい単位文字列に整形する。
類似 API
- f StrFormatByteSizeEx — バイト数を読みやすい単位の文字列に整形する。
公式の関連項目
- f StrFormatByteSize64A — 64ビットのバイト数を見やすい単位文字列に整形する。