ClusterResourceControl

The ClusterResourceControl function initiates an operation affecting a resource.

DWORD WINAPI ClusterResourceControl(
  HRESOURCE hResource,  
  HNODE hHostNode,      
  DWORD dwControlCode,  
  LPVOID lpInBuffer,    
  DWORD cbInBufferSize,  
  LPVOID lpOutBuffer,   
  DWORD cbOutBufferSize, 
  LPDWORD lpcbBytesReturned  
);
 

Parameters

hResource

[in] Handle to the resource to be controlled.

hHostNode

[in] Optional handle to the node to perform the operation. If NULL, the node that owns the resource identified by hResource performs the operation.

dwControlCode

[in] Resource control code that defines the operation to be performed. For a list of the valid values for the dwControlCode parameter, see Control Codes for Resources.

lpInBuffer

[in] Pointer to a buffer with information needed for the operation, or NULL if no information is needed.

cbInBufferSize

[in] Number of bytes in the buffer pointed to by lpInBuffer.

lpOutBuffer

[out] Pointer to a buffer with information resulting from the operation, or NULL if nothing need be returned.

cbOutBufferSize

[in] Number of bytes in the buffer pointed to by lpOutBuffer.

lpcbBytesReturned

[in, out] Pointer to the number of bytes of lpOutBuffer filled in as a result of the operation. The caller can pass NULL for lpcbBytesReturned if ClusterResourceControl need not pass back the number of bytes in the output buffer.

Return Values

ERROR_SUCCESS

The operation was successful.

ERROR_MORE_DATA

The output buffer pointed to by lpOutBuffer is not large enough to hold the data being returned. The lpcbBytesReturned parameter points to the size required for the output buffer.

If the operation was unsuccessful, ClusterResourceControl returns a Win32 error value.

Remarks

ClusterResourceControl is a general-purpose function for initiating an operation that affects a resource. The scope of allowable operations is defined by the set of control codes specified for resources. For a complete description of how to use control codes and control code functions, see Cluster Control Codes.

When ClusterResourceControl returns ERROR_MORE_DATA, set cbOutBufferSize to the number of bytes pointed to by lpcbBytesReturned and call the function again.

QuickInfo

  Version: Use Windows NT Server Enterprise Edition 4.0.
  Windows CE: Unsupported.
  Header: Declared in clusapi.h.