ClusterNetInterfaceControl

The ClusterNetInterfaceControl function initiates an operation affecting a network interface.

DWORD WINAPI ClusterNetInterfaceControl(
  HNETINTERFACE hNetInterface,     
  HNODE hHostNode,       
  DWORD dwControlCode,   
  LPVOID lplnBuffer,     
  DWORD cblnBufferSize,   
  LPVOID lpOutBuffer,    
  DWORD cbOutBufferSize,  
  LPDWORD lpcbBytesReturned  
);
 

Parameters

hNetInterface

[in] Handle to the network interface to be affected by the operation.

hHostNode

[in] Optional handle to the node hosting the affected network interface.

dwControlCode

[in] Control code that defines the operation to perform. For a list of the valid values for the dwControlCode parameter, see Control Codes for Network Interfaces.

lplnBuffer

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

cblnBufferSize

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

lpOutBuffer

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

cbOutBufferSize

[in] 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.

lpcbBytesReturned

[in, out] 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 lpcbBytesReturned if ClusterNetInterfaceControl 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, ClusterNetInterfaceControl returns a Win32 error value.

Remarks

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

When ClusterNetInterfaceControl 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.