Windows Dev Center

ClusterIsPathOnSharedVolume function

Determines whether a path is on a cluster shared volume (CSV). This is used to determine whether ClusterGetVolumeNameForVolumeMountPoint or ClusterGetVolumePathName should be called instead of GetVolumeNameForVolumeMountPoint or GetVolumePathName. The PCLUSTER_IS_PATH_ON_SHARED_VOLUME type defines a pointer to this function.

Syntax


BOOL WINAPI ClusterIsPathOnSharedVolume(
  _In_ LPCWSTR lpszPathName
);

typedef BOOL (WINAPI *PCLUSTER_IS_PATH_ON_SHARED_VOLUME)(
    _In_ LPCWSTR lpszPathName
);

Parameters

lpszPathName [in]

A pointer to the input path string.

Return value

TRUE if the path is on a CSV and this function is called from a domain account, or if the path is on a CSV that is owned by a local cluster node; otherwise, FALSE.

Remarks

The ClusterIsPathOnSharedVolume function must be called from a node of the cluster.

The following table explains the possible return values based on the type of cluster node that owns the CSV and the type of user account that calls this function.

User Account Type
CSV OwnershipLocalDomain
Local Cluster NodeTRUETRUE
Other Cluster NodeFALSETRUE

 

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2 Enterprise, Windows Server 2008 R2 Datacenter

Header

ResApi.h

Library

ResUtils.Lib

DLL

ResUtils.Dll

See also

Backup and Restore Functions
Backing Up and Restoring the Failover Cluster Configuration Using VSS
GetVolumePathName

 

 

Show:
© 2015 Microsoft