OpenClusterResourceEx function

Opens a resource and returns a handle to it.

Syntax


HRESOURCE WINAPI OpenClusterResourceEx(
  _In_      HCLUSTER hCluster,
  _In_opt_  LPCWSTR  lpszResourceName,
  _In_      DWORD    dwDesiredAccess,
  _Out_opt_ DWORD    *lpdwGrantedAccess
);

typedef HRESOURCE (WINAPI *PCLUSAPI_OPEN_CLUSTER_RESOURCE_EX)(
    _In_      HCLUSTER hCluster,
    _In_opt_  LPCWSTR  lpszResourceName,
    _In_      DWORD    dwDesiredAccess,
    _Out_opt_ LPDWORD  lpdwGrantedAccess
);

Parameters

hCluster [in]

Handle to a cluster.

lpszResourceName [in, optional]

Pointer to a null-terminated Unicode string containing the name of the resource to be opened.

Resource names are not case sensitive. A resource name must be unique within the cluster. The name is set when the resource is created and can be changed using the SetClusterResourceName function.

dwDesiredAccess [in]

The requested access privileges. This may be any combination of GENERIC_READ (0x80000000), GENERIC_ALL (0x10000000), or MAXIMUM_ALLOWED (0x02000000). If this value is zero (0) and undefined error may be returned. Using GENERIC_ALL is the same as calling OpenClusterResource.

lpdwGrantedAccess [out, optional]

Optional parameter that contains the address of a DWORD that will receive the access rights granted. If the DesiredAccess parameter is MAXIMUM_ALLOWED (0x02000000) then the DWORD pointed to by this parameter will contain the maximum privileges granted to this user.

Return value

If the operation was successful, OpenClusterResourceEx returns a handle to the opened resource.

NULL

The operation was not successful. For more information about the error, call the GetLastError function. If the target server does not support the OpenClusterResourceEx function (for example if the target server is running Windows Server 2008 or earlier) then the GetLastError function will return RPC_S_PROCNUM_OUT_OF_RANGE (1745).

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2 Datacenter, Windows Server 2008 R2 Enterprise

Header

ClusAPI.h

Library

ClusAPI.lib

DLL

ClusAPI.dll

See also

Failover Cluster Resource Management Functions
CloseClusterResource
OpenClusterResource

 

 

Show: