PathBuildRoot function
Creates a root path from a given drive number.
Syntax
LPTSTR PathBuildRoot(
_Out_ LPTSTR szRoot,
_In_ int iDrive
);
Parameters
- szRoot [out]
-
Type: LPTSTR
A pointer to the string that receives the constructed root path. This buffer must be at least four characters in size.
- iDrive [in]
-
Type: int
A variable of type int that indicates the desired drive number. It should be between 0 and 25.
Return value
Type: LPTSTR
Returns the address of the constructed root path. If the call fails for any reason (for example, an invalid drive number), szRoot is returned unchanged.
Examples
#include <windows.h> #include <iostream.h> #include "Shlwapi.h" void main( void ) { // String for root name char buffer_1[4]; char *lpStr1; lpStr1 = buffer_1; // Generate a root path based on the drive number (0/25) // "Example: 0=A: to 25=Z:" cout << "The root path for 0 is " << PathBuildRoot(lpStr1,0) << endl; cout << "The root path for 1 is " << PathBuildRoot(lpStr1,1) << endl; cout << "The root path for 25 is " << PathBuildRoot(lpStr1,25) << endl; } OUTPUT: --------------- The root path for 0 is A:\ The root path for 1 is B:\ The root path for 25 is Z:\
Requirements
|
Minimum supported client |
Windows 2000 Professional, Windows XP [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows 2000 Server [desktop apps only] |
|
Header |
|
|
Library |
|
|
DLL |
|
|
Unicode and ANSI names |
PathBuildRootW (Unicode) and PathBuildRootA (ANSI) |