IsFileOnClusterSharedVolume function (clusapi.h)

Specifies whether the file is on the cluster shared volume.

Syntax

DWORD IsFileOnClusterSharedVolume(
  [in]  LPCWSTR lpszPathName,
  [out] PBOOL   pbFileIsOnSharedVolume
);

Parameters

[in] lpszPathName

A Unicode string that specifies the path of the cluster shared volume. The string ends with a terminating null character.

[out] pbFileIsOnSharedVolume

True if the file is on the cluster shared volume; otherwise false.

Return value

If the function succeeds, it returns ERROR_SUCCESS.

If the function fails, it returns one of the system error codes.

Requirements

Requirement Value
Minimum supported client None supported
Minimum supported server Windows Server 2008 R2 Datacenter, Windows Server 2008 R2 Enterprise
Target Platform Windows
Header clusapi.h
Library ClusAPI.lib
DLL ClusAPI.dll

See also

Failover Cluster Resource Management Functions