CLUSCTL_NETWORK_GET_COMMON_PROPERTIES control code

Retrieves the read/write common properties for a network. Applications use this control code as a ClusterNetworkControl parameter.



ClusterNetworkControl( 
  hNetwork,                               // network handle
  hHostNode,                              // optional host node
  CLUSCTL_NETWORK_GET_COMMON_PROPERTIES,  // this control code
  NULL,                                   // input buffer (not used)
  0,                                      // input buffer size (not used)
  lpOutBuffer,                            // output buffer: property list
  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, points to a property list containing the specified network's read/write common network properties.

Return value

ClusterNetworkControl returns one of the following values.

ERROR_SUCCESS

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

ERROR_MORE_DATA

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, the operation failed. The value of lpcbBytesReturned is unreliable.

Remarks

For information on working with property lists, see Using Property Lists.

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

ComponentBit locationValue
Object code24–31

CLUS_OBJECT_NETWORK (0x5)

Global bit23

CLUS_NOT_GLOBAL (0x0)

Modify bit22

CLUS_NO_MODIFY (0x0)

User bit21

CLCTL_CLUSTER_BASE (0x0)

Type bit20

External (0x0)

Operation code0–23

CLCTL_GET_COMMON_PROPERTIES (0x59)

Access code0–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
Description

 

 

Show: