Retrieves the name of a mounted folder on the specified volume. FindFirstVolumeMountPoint is used to begin scanning the mounted folders on a volume.
Syntax
HANDLE WINAPI FindFirstVolumeMountPoint(
__in LPTSTR lpszRootPathName,
__out LPTSTR lpszVolumeMountPoint,
__in DWORD cchBufferLength
);
Parameters
- lpszRootPathName [in]
-
A volume GUID path for the volume to scan for mounted folders. A trailing backslash is required.
- lpszVolumeMountPoint [out]
-
A pointer to a buffer that receives the name of the first mounted folder that is found.
- cchBufferLength [in]
-
The length of the buffer that receives the path to the mounted folder, in TCHARs.
Return Value
If the function succeeds, the return value is a search handle used in a subsequent call to the
FindNextVolumeMountPoint and
FindVolumeMountPointClose functions.
If the function fails to find a mounted folder on the volume, the return value is the INVALID_HANDLE_VALUE error code. To get extended error information, call
GetLastError.
Remarks
The
FindFirstVolumeMountPoint function opens a mounted folder search handle and returns information about the first mounted folder that is found on the specified volume. After the search handle is established, you can use the
FindNextVolumeMountPoint
function to search for other mounted folders. When the search handle is no longer needed, close it with the
FindVolumeMountPointClose
function.
The FindFirstVolumeMountPoint, FindNextVolumeMountPoint, and FindVolumeMountPointClose functions return paths to mounted folders for a specified volume. They do not return drive letters or volume GUID paths. For information about enumerating the volume GUID paths for a volume, see Enumerating Volume GUID Paths.
You should not assume any correlation between the order of the mounted folders that are returned by these functions and the order of the mounted folders that are returned by other functions or tools.
Requirements
| Minimum supported client | Windows 2000 Professional |
| Minimum supported server | Windows 2000 Server |
| Header | WinBase.h (include Windows.h) |
| Library | Kernel32.lib |
| DLL | Kernel32.dll |
| Unicode and ANSI names | FindFirstVolumeMountPointW (Unicode) and FindFirstVolumeMountPointA (ANSI) |
See Also
- FindNextVolumeMountPoint
- FindVolumeMountPointClose
- Volume Management Functions
- Mounted Folders
Send comments about this topic to Microsoft
Build date: 11/12/2009