ClusterResourceTypeControl function (clusapi.h)

  • Article

Initiates an operation affecting a resource type. The operation performed depends on the control code passed to the dwControlCode parameter.

Syntax

DWORD ClusterResourceTypeControl(
  [in]            HCLUSTER hCluster,
  [in]            LPCWSTR  lpszResourceTypeName,
  [in, optional]  HNODE    hHostNode,
  [in]            DWORD    dwControlCode,
  [in, optional]  LPVOID   lpInBuffer,
  [in]            DWORD    nInBufferSize,
  [out, optional] LPVOID   lpOutBuffer,
  [in]            DWORD    nOutBufferSize,
  [out, optional] LPDWORD  lpBytesReturned
);

Parameters

[in] hCluster

Handle to the cluster containing the resource type identified in lpszResourceTypeName.

[in] lpszResourceTypeName

Pointer to a NULL-terminated Unicode string containing the name of the resource type to be affected.

[in, optional] hHostNode

Handle to the node hosting the affected resource type.

[in] dwControlCode

A resource type control code specifying the operation to be performed. For the syntax associated with a control code, refer to
Control Code Architecture and the following topics:

[in, optional] lpInBuffer

Pointer to the input buffer with information needed for the operation, or NULL if no information is needed.

[in] nInBufferSize

Number of bytes in the buffer pointed to by lpInBuffer.

[out, optional] lpOutBuffer

Pointer to the output buffer with information resulting from the operation, or NULL if nothing will be returned.

[in] nOutBufferSize

Number of bytes in the output buffer pointed to by lpOutBuffer, or zero if the caller does not know how much data will be returned.

[out, optional] lpBytesReturned

Pointer to the number of bytes in the buffer pointed to by lpOutBuffer that were actually filled in as a result of the operation. The caller can pass NULL for lpBytesReturned if ClusterResourceTypeControl does not need to pass back the number of bytes in the output buffer.

Return value

The function returns one of the following values.

Return code Description
ERROR_SUCCESS
 The operation was successful. If the operation required an output buffer, lpBytesReturned (if not NULL on input) points to the actual size of the data returned in the buffer.
ERROR_MORE_DATA
 The output buffer pointed to by lpOutBuffer was not large enough to hold the data resulting from the operation. The lpBytesReturned parameter (if not NULL on input) points to the size required for the output buffer. Only operations requiring an output buffer return ERROR_MORE_DATA. If the lpOutBuffer parameter is NULL and the nOutBufferSize parameter is zero, then ERROR_SUCCESS may be returned, not ERROR_MORE_DATA.
System error code
 The operation was not successful. If the operation required an output buffer, the value specified by lpBytesReturned is unreliable.

Remarks

When ClusterResourceTypeControl returns ERROR_MORE_DATA, set nOutBufferSize to the number of bytes pointed to by lpBytesReturned, and call the function again.

Do not pass LPC and RPC handles to the same function call. Otherwise, the call will raise an RPC exception and can have additional destructive effects. For information on how LPC and RPC handles are created, see LPC and RPC Handles and OpenCluster.

ClusterResourceTypeControl is one of the control code functions. For more information on control codes and control code functions, see Using Control Codes.

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

See also

OpenCluster

Resource Type Control Codes