SHGetDiskFreeSpaceExW 関数 (shellapi.h)

  • [アーティクル]

ディスク ボリュームのディスク領域情報を取得します。

構文

BOOL SHGetDiskFreeSpaceExW(
  [in]            LPCWSTR        pszDirectoryName,
  [out, optional] ULARGE_INTEGER *pulFreeBytesAvailableToCaller,
  [out, optional] ULARGE_INTEGER *pulTotalNumberOfBytes,
  [out, optional] ULARGE_INTEGER *pulTotalNumberOfFreeBytes
);

パラメーター

[in] pszDirectoryName

型: LPCTSTR

サイズ情報を取得するボリュームを指定する null で終わる文字列。 ドライブ文字、UNC 名、またはフォルダーのパスを指定できます。 現在のドライブを表すために NULL を 使用することはできません。

[out, optional] pulFreeBytesAvailableToCaller

種類: ULARGE_INTEGER*

呼び出し元アプリケーションで使用可能なボリュームのバイト数を受け取る値へのポインター。 オペレーティング システムがユーザーごとのクォータを実装している場合、この値はボリュームの空きバイトの合計数より小さい場合があります。

[out, optional] pulTotalNumberOfBytes

種類: ULARGE_INTEGER*

ボリュームの合計サイズをバイト単位で受け取る値へのポインター。

[out, optional] pulTotalNumberOfFreeBytes

種類: ULARGE_INTEGER*

ボリューム上の空き領域のバイト数を受け取る値へのポインター。

戻り値

種類: BOOL

成功した場合は TRUE 、それ以外の場合 は FALSE を 返します。

注釈

同様の名前の関数 SHGetDiskFreeSpace は、 SHGetDiskFreeSpaceEx のエイリアスにすぎません。 SHGetDiskFreeSpace を呼び出すと、実際にこの関数が呼び出されます。

この関数は、オペレーティング システムで使用可能な場合に GetDiskFreeSpaceEx 関数を呼び出します。 GetDiskFreeSpaceEx が使用できない場合は、GetDiskFreeSpace 関数を呼び出して戻り値を操作することでエミュレートされます。 詳細については、 GetDiskFreeSpaceEx のドキュメントを参照してください。

注意

shellapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SHGetDiskFreeSpaceEx を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional、Windows XP [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー shellapi.h
Library Shell32.lib
[DLL] Shell32.dll (バージョン 5.0 以降)

こちらもご覧ください

GetDiskFreeSpaceEx

SHGetDiskFreeSpace