StrFormatByteSize64A
関数64ビットのバイト数を見やすい単位文字列に整形する。
シグネチャ
// SHLWAPI.dll
#include <windows.h>
LPSTR StrFormatByteSize64A(
LONGLONG qdw,
LPSTR pszBuf,
DWORD cchBuf
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| qdw | LONGLONG | in | 変換する数値。 |
| pszBuf | LPSTR | out | この関数が正常に終了したときに、変換された数値を受け取るバッファへのポインター。 |
| cchBuf | DWORD | in | pszBuf が指すバッファのサイズ(文字数単位)。 |
戻り値の型: LPSTR
公式ドキュメント
数値を、そのサイズに応じてバイト、キロバイト、メガバイト、またはギガバイトで表現したサイズ値を表す文字列に変換します。
戻り値
型: PSTR
変換された文字列へのポインターを返します。変換に失敗した場合は NULL を返します。
解説(Remarks)
StrFormatByteSize64 は、ANSI 文字と Unicode 文字のどちらにも使用できます。ただし、StrFormatByteSize64A は直接呼び出せますが、StrFormatByteSize64W は定義されていません。StrFormatByteSize64 を Unicode 値で呼び出すと、StrFormatByteSizeW が使用されます。
Windows 10 では、サイズは 2 進数ではなく 10 進数で報告されます。たとえば、1 KB は 1024 バイトではなく 1000 バイトです。
次の表は、この関数が数値をテキスト文字列にどのように変換するかを示しています。
| 数値 | テキスト文字列 |
|---|---|
| 532 | 532 bytes |
| 1340 | 1.30 KB |
| 23506 | 23.5 KB |
| 2400016 | 2.40 MB |
| 2400000000 | 2.4 GB |
出典・ライセンス: 上記「公式ドキュメント」の内容は 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
#include <windows.h>
LPSTR StrFormatByteSize64A(
LONGLONG qdw,
LPSTR pszBuf,
DWORD cchBuf
);[DllImport("SHLWAPI.dll", ExactSpelling = true)]
static extern IntPtr StrFormatByteSize64A(
long qdw, // LONGLONG
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszBuf, // LPSTR out
uint cchBuf // DWORD
);<DllImport("SHLWAPI.dll", ExactSpelling:=True)>
Public Shared Function StrFormatByteSize64A(
qdw As Long, ' LONGLONG
<MarshalAs(UnmanagedType.LPStr)> pszBuf As System.Text.StringBuilder, ' LPSTR out
cchBuf As UInteger ' DWORD
) As IntPtr
End Function' qdw : LONGLONG
' pszBuf : LPSTR out
' cchBuf : DWORD
Declare PtrSafe Function StrFormatByteSize64A Lib "shlwapi" ( _
ByVal qdw As LongLong, _
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
StrFormatByteSize64A = ctypes.windll.shlwapi.StrFormatByteSize64A
StrFormatByteSize64A.restype = wintypes.LPSTR
StrFormatByteSize64A.argtypes = [
ctypes.c_longlong, # qdw : LONGLONG
wintypes.LPSTR, # pszBuf : LPSTR out
wintypes.DWORD, # cchBuf : DWORD
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('SHLWAPI.dll')
StrFormatByteSize64A = Fiddle::Function.new(
lib['StrFormatByteSize64A'],
[
Fiddle::TYPE_LONG_LONG, # qdw : LONGLONG
Fiddle::TYPE_VOIDP, # pszBuf : LPSTR out
-Fiddle::TYPE_INT, # cchBuf : DWORD
],
Fiddle::TYPE_VOIDP)#[link(name = "shlwapi")]
extern "system" {
fn StrFormatByteSize64A(
qdw: i64, // LONGLONG
pszBuf: *mut u8, // LPSTR out
cchBuf: u32 // DWORD
) -> *mut u8;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("SHLWAPI.dll")]
public static extern IntPtr StrFormatByteSize64A(long qdw, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszBuf, uint cchBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SHLWAPI_StrFormatByteSize64A' -Namespace Win32 -PassThru
# $api::StrFormatByteSize64A(qdw, pszBuf, cchBuf)#uselib "SHLWAPI.dll"
#func global StrFormatByteSize64A "StrFormatByteSize64A" sptr, sptr, sptr
; StrFormatByteSize64A qdw, varptr(pszBuf), cchBuf ; 戻り値は stat
; qdw : LONGLONG -> "sptr"
; pszBuf : LPSTR out -> "sptr"
; cchBuf : DWORD -> "sptr"
; ※HSP3.7は int64 引数(64bit値渡し)に非対応です。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "SHLWAPI.dll" #cfunc global StrFormatByteSize64A "StrFormatByteSize64A" int64, var, int ; res = StrFormatByteSize64A(qdw, pszBuf, cchBuf) ; qdw : LONGLONG -> "int64" ; pszBuf : LPSTR out -> "var" ; cchBuf : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。 ; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。#uselib "SHLWAPI.dll" #cfunc global StrFormatByteSize64A "StrFormatByteSize64A" int64, sptr, int ; res = StrFormatByteSize64A(qdw, varptr(pszBuf), cchBuf) ; qdw : LONGLONG -> "int64" ; pszBuf : LPSTR out -> "sptr" ; cchBuf : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。 ; ※int64 引数の DLL 値渡しは x64 ランタイム(hsp3_64)のみ対応(x86 は未対応)。
出力引数:
; LPSTR StrFormatByteSize64A(LONGLONG qdw, LPSTR pszBuf, DWORD cchBuf) #uselib "SHLWAPI.dll" #cfunc global StrFormatByteSize64A "StrFormatByteSize64A" int64, var, int ; res = StrFormatByteSize64A(qdw, pszBuf, cchBuf) ; qdw : LONGLONG -> "int64" ; pszBuf : LPSTR out -> "var" ; cchBuf : DWORD -> "int" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; LPSTR StrFormatByteSize64A(LONGLONG qdw, LPSTR pszBuf, DWORD cchBuf) #uselib "SHLWAPI.dll" #cfunc global StrFormatByteSize64A "StrFormatByteSize64A" int64, intptr, int ; res = StrFormatByteSize64A(qdw, varptr(pszBuf), cchBuf) ; qdw : LONGLONG -> "int64" ; pszBuf : LPSTR out -> "intptr" ; cchBuf : DWORD -> "int" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
shlwapi = windows.NewLazySystemDLL("SHLWAPI.dll")
procStrFormatByteSize64A = shlwapi.NewProc("StrFormatByteSize64A")
)
// qdw (LONGLONG), pszBuf (LPSTR out), cchBuf (DWORD)
r1, _, err := procStrFormatByteSize64A.Call(
uintptr(qdw),
uintptr(pszBuf),
uintptr(cchBuf),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // LPSTRfunction StrFormatByteSize64A(
qdw: Int64; // LONGLONG
pszBuf: PAnsiChar; // LPSTR out
cchBuf: DWORD // DWORD
): PAnsiChar; stdcall;
external 'SHLWAPI.dll' name 'StrFormatByteSize64A';result := DllCall("SHLWAPI\StrFormatByteSize64A"
, "Int64", qdw ; LONGLONG
, "Ptr", pszBuf ; LPSTR out
, "UInt", cchBuf ; DWORD
, "Ptr") ; return: LPSTR●StrFormatByteSize64A(qdw, pszBuf, cchBuf) = DLL("SHLWAPI.dll", "char* StrFormatByteSize64A(int64, char*, dword)")
# 呼び出し: StrFormatByteSize64A(qdw, pszBuf, cchBuf)
# qdw : LONGLONG -> "int64"
# pszBuf : LPSTR out -> "char*"
# cchBuf : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "shlwapi" fn StrFormatByteSize64A(
qdw: i64, // LONGLONG
pszBuf: [*c]u8, // LPSTR out
cchBuf: u32 // DWORD
) callconv(std.os.windows.WINAPI) [*c]const u8;proc StrFormatByteSize64A(
qdw: int64, # LONGLONG
pszBuf: ptr char, # LPSTR out
cchBuf: uint32 # DWORD
): cstring {.importc: "StrFormatByteSize64A", stdcall, dynlib: "SHLWAPI.dll".}pragma(lib, "shlwapi");
extern(Windows)
const(char)* StrFormatByteSize64A(
long qdw, // LONGLONG
char* pszBuf, // LPSTR out
uint cchBuf // DWORD
);ccall((:StrFormatByteSize64A, "SHLWAPI.dll"), stdcall, Cstring,
(Int64, Ptr{UInt8}, UInt32),
qdw, pszBuf, cchBuf)
# qdw : LONGLONG -> Int64
# pszBuf : LPSTR out -> Ptr{UInt8}
# cchBuf : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
const char* StrFormatByteSize64A(
int64_t qdw,
char* pszBuf,
uint32_t cchBuf);
]]
local shlwapi = ffi.load("shlwapi")
-- shlwapi.StrFormatByteSize64A(qdw, pszBuf, cchBuf)
-- qdw : LONGLONG
-- pszBuf : LPSTR out
-- cchBuf : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('SHLWAPI.dll');
const StrFormatByteSize64A = lib.func('__stdcall', 'StrFormatByteSize64A', 'void *', ['int64_t', 'char *', 'uint32_t']);
// StrFormatByteSize64A(qdw, pszBuf, cchBuf)
// qdw : LONGLONG -> 'int64_t'
// pszBuf : LPSTR out -> 'char *'
// cchBuf : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("SHLWAPI.dll", {
StrFormatByteSize64A: { parameters: ["i64", "buffer", "u32"], result: "pointer" },
});
// lib.symbols.StrFormatByteSize64A(qdw, pszBuf, cchBuf)
// qdw : LONGLONG -> "i64"
// pszBuf : LPSTR out -> "buffer"
// cchBuf : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
const char* StrFormatByteSize64A(
int64_t qdw,
char* pszBuf,
uint32_t cchBuf);
C, "SHLWAPI.dll");
// $ffi->StrFormatByteSize64A(qdw, pszBuf, cchBuf);
// qdw : LONGLONG
// 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);
Pointer StrFormatByteSize64A(
long qdw, // LONGLONG
byte[] pszBuf, // LPSTR out
int cchBuf // DWORD
);
}@[Link("shlwapi")]
lib LibSHLWAPI
fun StrFormatByteSize64A = StrFormatByteSize64A(
qdw : Int64, # LONGLONG
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 StrFormatByteSize64ANative = Pointer<Utf8> Function(Int64, Pointer<Utf8>, Uint32);
typedef StrFormatByteSize64ADart = Pointer<Utf8> Function(int, Pointer<Utf8>, int);
final StrFormatByteSize64A = DynamicLibrary.open('SHLWAPI.dll')
.lookupFunction<StrFormatByteSize64ANative, StrFormatByteSize64ADart>('StrFormatByteSize64A');
// qdw : LONGLONG -> Int64
// pszBuf : LPSTR out -> Pointer<Utf8>
// cchBuf : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function StrFormatByteSize64A(
qdw: Int64; // LONGLONG
pszBuf: PAnsiChar; // LPSTR out
cchBuf: DWORD // DWORD
): PAnsiChar; stdcall;
external 'SHLWAPI.dll' name 'StrFormatByteSize64A';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "StrFormatByteSize64A"
c_StrFormatByteSize64A :: Int64 -> CString -> Word32 -> IO CString
-- qdw : LONGLONG -> Int64
-- pszBuf : LPSTR out -> CString
-- cchBuf : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let strformatbytesize64a =
foreign "StrFormatByteSize64A"
(int64_t @-> string @-> uint32_t @-> returning string)
(* qdw : LONGLONG -> int64_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 ("StrFormatByteSize64A" str-format-byte-size64-a :convention :stdcall) :string
(qdw :int64) ; LONGLONG
(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 $StrFormatByteSize64A = Win32::API::More->new('SHLWAPI',
'LPSTR StrFormatByteSize64A(INT64 qdw, LPSTR pszBuf, DWORD cchBuf)');
# my $ret = $StrFormatByteSize64A->Call($qdw, $pszBuf, $cchBuf);
# qdw : LONGLONG -> INT64
# pszBuf : LPSTR out -> LPSTR
# cchBuf : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目
- f StrFormatByteSizeW — 64ビットのバイト数を見やすい単位文字列に整形する。