GetDiskFreeSpaceA 関数 (fileapi.h)
指定したディスクに関する情報 (ディスク上の空き領域を含む) を取得します。
構文
BOOL GetDiskFreeSpaceA(
[in] LPCSTR lpRootPathName,
[out] LPDWORD lpSectorsPerCluster,
[out] LPDWORD lpBytesPerSector,
[out] LPDWORD lpNumberOfFreeClusters,
[out] LPDWORD lpTotalNumberOfClusters
);
パラメーター
[in] lpRootPathName
情報が返されるディスクのルート ディレクトリ。 このパラメーターが NULL の場合、関数は現在のディスクのルートを使用します。 このパラメーターが UNC 名の場合は、末尾の円記号 ("\\MyServer\MyShare\" など) を含める必要があります。 さらに、ドライブの仕様には、末尾の円記号 ("C:\" など) が必要です。 呼び出し元のアプリケーションには、このディレクトリ FILE_LIST_DIRECTORY アクセス権が必要です。
[out] lpSectorsPerCluster
クラスターあたりのセクター数を受け取る変数へのポインター。
[out] lpBytesPerSector
セクターあたりのバイト数を受け取る変数へのポインター。
[out] lpNumberOfFreeClusters
呼び出し元スレッドに関連付けられているユーザーが使用できるディスク上の空きクラスターの合計数を受け取る変数へのポインター。
ユーザーごとのディスク クォータが使用されている場合、この値はディスク上の空きクラスターの合計数よりも少なくなる可能性があります。
[out] lpTotalNumberOfClusters
呼び出し元スレッドに関連付けられているユーザーが使用できるディスク上のクラスターの合計数を受け取る変数へのポインター。
ユーザーごとのディスク クォータが使用されている場合、この値はディスク上のクラスターの合計数よりも少なくなる可能性があります。
戻り値
関数が成功すると、戻り値は 0 以外になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
GetDiskFreeSpaceEx 関数を使用すると、GetDiskFreeSpace 関数に必要な算術演算の一部を回避できます。
シンボリック リンクの動作 : パスがシンボリック リンクを指している場合、操作はターゲットに対して実行されます。
注意
fileapi.h ヘッダーは、GetDiskFreeSpace をエイリアスとして定義します。このエイリアスは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP [デスクトップ アプリ | UWP アプリ] |
| サポートされている最小のサーバー | Windows Server 2003 [デスクトップ アプリのみ | UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | fileapi.h (Windows.h を含む) |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |