SetupQueryDrivesInDiskSpaceListA 関数 (setupapi.h)
[この機能は、「要件」セクションに示されているオペレーティング システムで使用できます。 今後のバージョンでは変更されるか、利用できなくなる場合もあります。 SetupAPI は、アプリケーションのインストールに使用されなくなりました。 代わりに、アプリケーション インストーラーを開発するために Windows インストーラーを使用します。 SetupAPI は、デバイス ドライバーのインストールに引き続き使用されます。]
SetupQueryDrivesInDiskSpaceList 関数は、ディスク領域の一覧に一覧表示されているファイル操作によって参照されるドライブの一覧をバッファーに格納します。
構文
WINSETUPAPI BOOL SetupQueryDrivesInDiskSpaceListA(
[in] HDSKSPC DiskSpace,
[in, out] PSTR ReturnBuffer,
[in] DWORD ReturnBufferSize,
[in, out] PDWORD RequiredSize
);
パラメーター
[in] DiskSpace
ディスク領域の一覧を処理します。
[in, out] ReturnBuffer
"X:" や "\server\share" など、ドライブの仕様を受け取るバッファーへのオプションのポインター。 null で終わる文字列を使用する必要があります。 null で終わる文字列は、宛先バッファーのサイズを超えてはなりません。 このパラメーターは、NULL でもかまいません。 このパラメーターが指定されておらず、エラーが発生しない場合、この関数は 0 以外の値を返し、 RequiredSize は ドライブの仕様を保持するために必要なバッファー サイズを受け取ります。
[in] ReturnBufferSize
ReturnBuffer が指すバッファーのサイズ (文字数)。 これには 、null ターミネータが含まれます。 ReturnBuffer が指定されていない場合、このパラメーターは無視されます。
[in, out] RequiredSize
ドライブの null で終わるリストを文字で保持するために必要なバッファーのサイズを受け取る変数へのオプションのポインター。 これには 、null ターミネータが含まれます。
戻り値
関数が成功した場合、戻り値は 0 以外の値になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
GetLastError 関数がERROR_INSUFFICIENT_BUFFERを返す場合、ReturnBuffer が指定されましたが、ReturnBufferSize は指定されたバッファーが小さすぎることを示しました。
注釈
注意
setupapi.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして SetupQueryDrivesInDiskSpaceList を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows XP (デスクトップ アプリのみ) |
サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
対象プラットフォーム | Windows |
ヘッダー | setupapi.h |
Library | Setupapi.lib |
[DLL] | Setupapi.dll |