GetLogicalDriveStrings
The GetLogicalDriveStrings
function fills a buffer with strings that specify valid drives in the system.
DWORD GetLogicalDriveStrings(
|
DWORD nBufferLength, |
// size of buffer |
|
LPTSTR lpBuffer |
// address of
buffer for drive strings |
|
); |
|
Parameters
nBufferLength
Specifies the
maximum size, in characters, of the buffer pointed to by lpBuffer. This
size does not include the terminating null character.
lpBuffer
Points to a
buffer that receives a series of null-terminated strings, one for each valid
drive in the system, that end with a second null character. The following
example shows the buffer contents with <null> representing the
terminating null character.
c:\<null>d:\<null><null>
Return Values
If the
function succeeds, the return value is the length, in characters, of the
strings copied to the buffer, not including the terminating null character.
Note that an ANSI-ASCII null character uses one byte, but a Unicode null
character uses two bytes.
If the buffer
is not large enough, the return value is greater than nBufferLength. It
is the size of the buffer required to hold the drive strings.
If the
function fails, the return value is zero. To get extended error information,
use the GetLastError
function.
Remarks
Each string
in the buffer may be used wherever a root directory is required, such as for
the GetDriveType and GetDiskFreeSpace functions.
See Also