SHGetDiskFreeSpaceExA 関数 (shellapi.h)

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

構文

BOOL SHGetDiskFreeSpaceExA(
  [in]            LPCSTR         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 を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。

必要条件

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

関連項目

GetDiskFreeSpaceEx を する

SHGetDiskFreeSpace を する