CLUSPROP_PROPERTY_NAME_DECLARE macro (clusapi.h)

Article
02/22/2024

Creates a CLUSPROP_PROPERTY_NAME structure with the sz member set to a size determined by the caller.

Syntax

void CLUSPROP_PROPERTY_NAME_DECLARE(
   name,
   cch
);

Parameters

name

Name of the CLUSPROP_PROPERTY_NAME structure to be created.

cch

The size (that is, count of characters) of the sz member array. This value must be a constant.

Return value

None

Remarks

ClusAPI.h defines CLUSPROP_PROPERTY_NAME_DECLARE as follows:

#define CLUSPROP_PROPERTY_NAME_DECLARE( name, cch ) \
    struct {                                        \
        CLUSPROP_SYNTAX Syntax;                     \
        DWORD           cbLength;                   \
        WCHAR           sz[(cch + 1) &amp; ~1];         \
    } name

Examples

The following example shows how to use CLUSPROP_PROPERTY_NAME_DECLARE. For another example, see Creating Physical Disk Resources.

WCHAR szName[] = L"Name";
CLUSPROP_PROPERTY_NAME_DECLARE( PropName, sizeof( szName ) / sizeof( WCHAR ) );
PropName.Syntax.dw = CLUSPROP_SYNTAX_LIST_VALUE_SZ;
PropName.cbLength  = sizeof( szName );
StringCbCopy( PropName.sz, PropName.cbLength, szName );

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008 Enterprise, Windows Server 2008 Datacenter
Target Platform	Windows
Header	clusapi.h