Share via


Name

Provides the name of the network being managed by a Cluster Name resource. The following table summarizes the attributes of the Name property.

Attribute Value
Data type
Null-terminated Unicode string
Access
Read/write
Status
Required
Structure
CLUSPROP_SZ
Minimum
NULL
Maximum
see Maximum String Size
Default
NULL

Remarks

Every cluster has a core Cluster Name resource. The core Network Name resource stores the cluster name in its Name private property and is used by the Cluster service to manage the cluster name. The Name private property of the core Cluster Name resource is read-only. Applications must call the SetClusterName function to change the cluster name.

The Name private property for all other Cluster Name resources is read/write.

Note that the Name common property for a Cluster Name resource provides the name of the resource, not the name of the network.

The CLUSPROP_SZ_DECLARE macro creates a CLUSPROP_SZ structure with an array of the correct size.

Examples

The property value portion of a property list entry for Name can be set with the following example code.

WCHAR                szNameData[] = L"myCluster";
CLUSPROP_SZ_DECLARE( NameValue, sizeof( szNameData ) / sizeof( WCHAR ) );

NameValue.Syntax.dw = CLUSPROP_SYNTAX_LIST_VALUE_SZ;
NameValue.cbLength  = sizeof( szNameData );
StringCbCopy( NameValue.sz, NameValue.cbLength, szNameData );

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2008 Enterprise, Windows Server 2008 Datacenter

See also

Cluster Name Private Properties

CLUSPROP_SZ

CLUSPROP_SZ_DECLARE

SetClusterName