CLUSCTL_GROUP_ENUM_PRIVATE_PROPERTIES control code

Retrieves a list of the private property names for a group. Applications use this control code as a ClusterGroupControl parameter.



ClusterGroupControl( 
  hGroup,                                 // group handle
  hHostNode,                              // optional node handle
  CLUSCTL_GROUP_ENUM_PRIVATE_PROPERTIES,  // this control code
  NULL,                                   // input buffer (not used)
  0,                                      // input buffer size (not used)
  lpOutBuffer,                            // output buffer: array of strings
  cbOutBufferSize,                        // output buffer size (bytes)
  lpcbBytesReturned                       // resulting data size (bytes)
);

Parameters

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

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 group private property.

Return value

ClusterGroupControl 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 groups.

Do not use any group control codes in any resource DLL entry point function. Group control codes can safely be called from a worker thread. For more information, see Function Calls to Avoid in Resource DLLs.

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

ComponentBit locationValue
Object code24–31CLUS_OBJECT_GROUP (0x3)
Global bit23CLUS_NOT_GLOBAL (0x0)
Modify bit22CLUS_NO_MODIFY (0x0)
User bit21CLCTL_CLUSTER_BASE (0x0)
Type bit20External (0x0)
Operation code0–23CLCTL_ENUM_PRIVATE_PROPERTIES (0x79)
Access code0–1CLUS_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

Group Control Codes
ClusterGroupControl

 

 

Show: