StrFormatByteSizeEx 関数 (shlwapi.h)

  • [アーティクル]

サイズに応じて、数値をバイト数、キロバイト単位、メガバイト単位、またはギガバイト単位で表す文字列に変換します。 表示される最も近い数字に丸めるか、表示されていない数字を破棄するオプションを提供することで 、StrFormatByteSizeW を拡張します。

構文

LWSTDAPI StrFormatByteSizeEx(
        ULONGLONG  ull,
        SFBS_FLAGS flags,
  [out] PWSTR      pszBuf,
        UINT       cchBuf
);

パラメーター

ull

種類: ULONGLONG

変換する数値。

flags

種類: SFBS_FLAGS

表示されていない数字を丸めるか切り捨てるかを指定する SFBS_FLAGS 列挙値の 1 つ。 この値を NULL にすることはできません。

[out] pszBuf

種類: PWSTR

変換された文字列を受け取るバッファーへのポインター。

cchBuf

型: UINT

pszBuf が指すバッファーのサイズ (文字単位)。

戻り値

種類: HRESULT

この関数が成功すると、 S_OKが返されます。 そうでない場合は、HRESULT エラー コードを返します。

解説

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

数値 フラグ テキスト文字列
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 バイトです。

要件

   
サポートされている最小のクライアント Windows Vista と SP1 [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー shlwapi.h
Library Shlwapi.lib
[DLL] Shlwapi.dll (バージョン 6.0 以降)

関連項目

StrFormatByteSize64

StrFormatByteSizeA

StrFormatByteSizeW