GetClusterResourceNetworkName function (clusapi.h)

Article
02/22/2024

Retrieves the Name private property of the Network Name resource on which a resource is dependent. The PCLUSAPI_GET_CLUSTER_RESOURCE_NETWORK_NAME type defines a pointer to this function.

Syntax

BOOL GetClusterResourceNetworkName(
  [in]      HRESOURCE hResource,
  [out]     LPWSTR    lpBuffer,
  [in, out] LPDWORD   nSize
);

Parameters

[in] hResource

Handle to the dependent resource.

[out] lpBuffer

Buffer containing a null-terminated Unicode string that contains the Name private property of the Network Name resource on which the resource depends.

[in, out] nSize

On input, pointer to a count of characters in the buffer pointed to by lpBuffer. On output, pointer to a count of characters in the network name of the Network Name resource contained in the buffer pointed to by lpBuffer, excluding the null-terminating character.

Return value

If the operation succeeds, the function returns TRUE.

If the operation fails, the function returns FALSE. For more information about the error, call GetLastError.

Remarks

Do not call GetClusterResourceNetworkName from any resource DLL entry point function. GetClusterResourceNetworkName can safely be called from a worker thread. For more information, see Function Calls to Avoid in Resource DLLs.

Requirements

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