FindFirstVolumeMountPointA function

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 FindFirstVolumeMountPointA(
  LPCSTR lpszRootPathName,
  LPSTR  lpszVolumeMountPoint,
  DWORD  cchBufferLength
);

Parameters

lpszRootPathName

A volume GUID path for the volume to scan for mounted folders. A trailing backslash is required.

lpszVolumeMountPoint

A pointer to a buffer that receives the name of the first mounted folder that is found.

cchBufferLength

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.

In Windows 8 and Windows Server 2012, this function is supported by the following technologies.

Technology Supported
Server Message Block (SMB) 3.0 protocol No
SMB 3.0 Transparent Failover (TFO) No
SMB 3.0 with Scale-out File Shares (SO) No
Cluster Shared Volume File System (CsvFS) No
Resilient File System (ReFS) No
 

SMB does not support volume management functions. CsvFS does not support adding mount point on a CSV volume. ReFS does not index mount points.

Requirements

   
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header winbase.h (include Windows.h)
Library Kernel32.lib
DLL Kernel32.dll

See Also

FindNextVolumeMountPoint

FindVolumeMountPointClose

Mounted Folders

Volume Management Functions