CLUSCTL_GROUP_ENUM_COMMON_PROPERTIES control code

Статья
05/31/2018

Retrieves a list of the read/write group common 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_COMMON_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 common property.

Return value

ClusterGroupControl 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

234 (0xEA)

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

The CLUSCTL_GROUP_ENUM_COMMON_PROPERTIES control code returns only property names, not property values. To retrieve values for common group properties, use CLUSCTL_GROUP_GET_COMMON_PROPERTIES and CLUSCTL_GROUP_GET_RO_COMMON_PROPERTIES.

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_COMMON_PROPERTIES as follows (for more information, see Control Code Architecture).

Component	Bit location	Value
Object code	24 31	CLUS_OBJECT_GROUP (0x3)
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_COMMON_PROPERTIES (0x51)
Access code	0 1	CLUS_ACCESS_READ (0x1)

Examples

#include "ClusDocEx.h"
//////////////////////////////////////////////////////////////////////
// ClusDocEx_IsGroupProperty
//
// Verifies that a string corresponds to a common group property name.
//
// Arguments:
//    IN HGROUP hGroup        Group handle.
//    IN LPWSTR lpszPropName  Possible property name to verify.
//
// Return Values
//    1   The string contains a group common property name.
//    0   The string does not match any common group property name.
//   -1   Results unknown - an error occurred. Call GetLastError for more info.
//////////////////////////////////////////////////////////////////////
int ClusDocEx_IsGroupProperty
(
    IN HGROUP hGroup,
    IN LPWSTR lpszPropName
)
{
    DWORD  dwResult    = 0;
    DWORD  cbAllocated = 256;
    DWORD  cbRequired  = 0;
    DWORD  cbBufferPos = 0;
    LPVOID lpOutBuffer = LocalAlloc( LPTR, cbAllocated );
    LPWSTR lpszParser  = NULL;
    int    intGroupProperty = -1;

    //
    // Basic bounds checking.
    //
    if( lpOutBuffer == NULL )
    {
        dwResult = GetLastError();
        goto EndFunc;
    }
    if( lpszPropName == NULL || hGroup == NULL )
    {
        dwResult = ERROR_BAD_ARGUMENTS;
        goto EndFunc;
    }

    //
    // First call.
    //
    dwResult = ClusterGroupControl( hGroup,
                                    NULL,
                                    CLUSCTL_GROUP_ENUM_COMMON_PROPERTIES,
                                    NULL,
                                    0,
                                    lpOutBuffer,
                                    cbAllocated,
                                    &amp;cbRequired );

    //
    // Reallocation routine.
    //
    if( dwResult == ERROR_MORE_DATA )
    {
        LocalFree( lpOutBuffer );
        cbAllocated = cbRequired;
        lpOutBuffer = LocalAlloc( LPTR, cbAllocated );
        dwResult = ClusterGroupControl( hGroup,
                                        NULL,
                                        CLUSCTL_GROUP_ENUM_COMMON_PROPERTIES,
                                        NULL,
                                        0,
                                        lpOutBuffer,
                                        cbAllocated,
                                        &amp;cbRequired );
    }

    //
    // Parse the output buffer (array of strings) to
    // find the specified property name.
    //
    if( dwResult == ERROR_SUCCESS )
    {
        cbBufferPos = 0;
        lpszParser = (LPWSTR)lpOutBuffer;

        if( lpOutBuffer == NULL )
        {
            dwResult = GetLastError();
            goto EndFunc;
        }

        while(1)
        {
            if( lstrcmpi( lpszPropName, lpszParser ) == 0 )
            {
                intGroupProperty = 1;
                break;
            }

            cbBufferPos += ( lstrlenW(lpszParser) + 1 ) * sizeof( WCHAR );

            if( cbBufferPos < cbRequired )
            {
                lpszParser += lstrlenW(lpszParser) + 1;
            }
            else
            {
                intGroupProperty = 0;
                break;
            }
        }
    }

EndFunc:

    LocalFree( lpOutBuffer );
    SetLastError( dwResult );
    return intGroupProperty;

}

Requirements


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