ClusterResourceOpenEnumEx function

Opens a handle to a resource enumeration that enables iteration through a resource's dependencies and nodes.

Syntax


HRESENUM WINAPI ClusterResourceOpenEnumEx(
  _In_     HCLUSTER hCluster,
  _In_opt_ LPCWSTR  lpszProperties,
  _In_     DWORD    cbProperties,
  _In_opt_ LPCWSTR  lpszRoProperties,
  _In_     DWORD    cbRoProperties,
  _In_     DWORD    dwFlags
);

typedef HRESENUMEX (WINAPI *PCLUSAPI_CLUSTER_RESOURCE_OPEN_ENUM_EX)(
    _In_     HCLUSTER hCluster,
    _In_opt_ LPCWSTR  lpszProperties,
    _In_     DWORD    cbProperties,
    _In_opt_ LPCWSTR  lpszRoProperties,
    _In_     DWORD    cbRoProperties,
    _In_     DWORD    dwFlags
);

Parameters

hCluster [in]

A handle to the resource to iterate through.

lpszProperties [in, optional]

A pointer to a list of names of common properties.

cbProperties [in]

The size, in bytes, of the lpszProperties parameter.

lpszRoProperties [in, optional]

A pointer to a list of names of read-only common properties.

cbRoProperties [in]

The size, in bytes, of the lpszRoProperties parameter.

dwFlags [in]

The index that identifies the next object to enumerate. This parameter should be zero for the first call to ClusterResourceOpenEnumEx and then be incremented for subsequent calls.

Return value

If the operation succeeds, the function returns an enumeration handle.

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

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012

Header

ClusAPI.h

Library

ClusAPI.lib

DLL

ClusAPI.dll

See also

Failover Cluster Resource Management Functions

 

 

Show: