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 (デスクトップ アプリのみ) |
| 対象プラットフォーム | Windows |
| ヘッダー | shellapi.h |
| Library | Shell32.lib |
| [DLL] | Shell32.dll (バージョン 5.0 以降) |