CLUSCTL_NETWORK_ENUM_PRIVATE_PROPERTIES control code

Retrieves a list of private property names for a network. Applications use this control code as a ClusterNetworkControl parameter.

ClusterNetworkControl( 
  hNetwork,                                 // network handle
  hHostNode,                                // optional host node
  CLUSCTL_NETWORK_ENUM_PRIVATE_PROPERTIES,  // this control code
  NULL,                                     // input buffer (not used)
  0,                                        // input buffer size (not used)
  lpOutBuffer,                              // output buffer: array of strings
  cbOutBufferSize,                          // allocated buffer size (bytes)
  lpcbBytesReturned                         // actual size of resulting data (bytes)
);

Parameters

The following control code function parameter is specific to this control code. For complete parameter descriptions, see ClusterNetworkControl.

lpOutBuffer

On a successful return, lpOutBuffer contains an array of null-terminated Unicode strings with an additional NULL terminator appended to the last string. Each string in the array contains the name of a read/write network private property.

Return value

ClusterNetworkControl returns one of the following values.

ERROR_SUCCESS

0

The operation completed successfully. The lpcbBytesReturned parameter points to the actual size of the returned data.

ERROR_MORE_DATA

234 (0xEA)

More data is available. The output buffer pointed to by lpOutBuffer was not large enough to hold the data resulting from the operation. The lpcbBytesReturned parameter points to the size required for the output buffer.

System error code

If any other value is returned, then the operation failed. The value of lpcbBytesReturned is unreliable.

Remarks

By default, failover clusters do not define any private properties for networks.

ClusAPI.h defines the 32 bits of CLUSCTL_NETWORK_ENUM_PRIVATE_PROPERTIES as follows (for more information, see Control Code Architecture).

Component	Bit location	Value
Object code	24 31	CLUS_OBJECT_NETWORK (0x5)
Global bit	23	CLUS_NOT_GLOBAL (0x0)
Modify bit	22	CLUS_NO_MODIFY (0x0)
User bit	21	CLCTL_CLUSTER_BASE (0x0)
Type bit	20	External (0x0)
Operation code	0 23	CLCTL_ENUM_PRIVATE_PROPERTIES (0x79)
Access code	0 1	CLUS_ACCESS_READ (0x1)

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Header	ClusAPI.h

See also

Network Control Codes

ClusterNetworkControl