SetupQueryDrivesInDiskSpaceList function

[This function is available for use in the operating systems indicated in the Requirements section. It may be altered or unavailable in subsequent versions. SetupAPI should no longer be used for installing applications. Instead, use the Windows Installer for developing application installers. SetupAPI continues to be used for installing device drivers.]

The SetupQueryDrivesInDiskSpaceList function fills a buffer with a list of the drives referenced by the file operations listed in the disk-space list.

Syntax


BOOL SetupQueryDrivesInDiskSpaceList(
  _In_    HDSKSPC DiskSpace,
  _Inout_ PSTR    ReturnBuffer,
  _In_    DWORD   ReturnBufferSize,
  _Inout_ PDWORD  RequiredSize
);

Parameters

DiskSpace [in]

Handle to the disk-space list.

ReturnBuffer [in, out]

Optional pointer to a buffer that receives the drive specifications, such as "X:" or "\\server\share". You should use a null-terminated string. The null-terminated string should not exceed the size of the destination buffer. This parameter can be NULL. If this parameter is not specified and no error occurs, the function returns a nonzero value and RequiredSize receives the buffer size required to hold the drive specifications.

ReturnBufferSize [in]

Size of the buffer pointed by ReturnBuffer, in characters. This includes the null terminator. This parameter is ignored if ReturnBuffer is not specified.

RequiredSize [in, out]

Optional pointer to a variable that receives the size of the buffer required to hold the null-terminated list of drives, in characters. This includes the null terminator.

Return value

If the function succeeds, the return value is a nonzero value.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

If the GetLastError function returns ERROR_INSUFFICIENT_BUFFER, ReturnBuffer was specified, but ReturnBufferSize indicated that the supplied buffer was too small.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Setupapi.h

Library

Setupapi.lib

DLL

Setupapi.dll

Unicode and ANSI names

SetupQueryDrivesInDiskSpaceListW (Unicode) and SetupQueryDrivesInDiskSpaceListA (ANSI)

See also

Overview
Functions
SetupQuerySpaceRequiredOnDrive

 

 

Show: