GetDiskFreeSpaceW

指定したディスクに関する情報(ディスクの空き領域量を含む)を取得する。(Unicode)

GetDiskFreeSpaceW lpRootPathName, lpSectorsPerCluster, lpBytesPerSector, lpNumberOfFreeClusters, lpTotalNumberOfClusters

lpRootPathName : [wstr] 情報を返すディスクのルートディレクトリ。このパラメータが NULL の場合、関数は現在のディスクのルートを使う。このパラメータが UNC 名の場合、末尾にバックスラッシュを含めなければならない(例: "\\\\MyServer\\MyShare\\")。さらに、ドライブ指定には末尾にバックスラッシュが必要である(例: "C:\\")。呼び出し側のアプリケーションはこのディレクトリに対する FILE_LIST_DIRECTORY アクセス権を持っていなければならない。
lpSectorsPerCluster : [var] クラスタあたりのセクタ数を受け取る変数へのポインタ。
lpBytesPerSector : [var] セクタあたりのバイト数を受け取る変数へのポインタ。
lpNumberOfFreeClusters : [var] 呼び出し側スレッドに関連付けられたユーザーが利用可能な、ディスク上の空きクラスタ総数を受け取る変数へのポインタ。ユーザーごとのディスククォータが使われている場合、この値はディスク上の空きクラスタ総数より小さくなることがある。
lpTotalNumberOfClusters : [var] 呼び出し側スレッドに関連付けられたユーザーが利用可能な、ディスク上のクラスタ総数を受け取る変数へのポインタ。ユーザーごとのディスククォータが使われている場合、この値はディスク上のクラスタ総数より小さくなることがある。

(プラグイン / モジュール : kernel32.dll)

解説

指定したディスクに関する情報(ディスクの空き領域量を含む)を取得する。(Unicode)

[戻り値]
関数が成功した場合、戻り値は 0 以外である。関数が失敗した場合、戻り値は 0 である。拡張エラー情報を取得するには
GetLastError を呼ぶ。

[備考]
GetDiskFreeSpaceEx 関数を使うと、GetDiskFreeSpace
関数で必要となる演算の一部を避けることができる。シンボリックリンクの動作:
パスがシンボリックリンクを指している場合、操作はターゲットに対して実行される。
> [!NOTE] > fileapi.h ヘッダでは GetDiskFreeSpace が、UNICODE
プリプロセッサ定数の定義に応じて自動的に ANSI 版または Unicode
版を選択するエイリアスとして定義されている。エンコーディング中立のエイリアスを中立でないコードと混在させるとコンパイルや実行時のエラーになる可能性がある。詳細は
[Conventions for Function
Prototypes](/windows/win32/intl/conventions-for-function-prototypes)
を参照。

情報

プラグイン / モジュールkernel32.dll
バージョン1.0
作成日2026/04/16
著作者IronHSP / CsWin32 bridge
URLhttps://github.com/inovia/IronHSP
備考Win32 API の kernel32.dll 関数群。CsWin32 + win32metadata から自動生成。
hsp3net 専用 (intptr / NSTRUCT / wstr を使用)。
タイプ拡張命令
グループWin32API
対応環境
  • Windows 版 HSP
hs ファイルhsphelp\win32_kernel32_gen2.hs