MulticastAddress

[The MulticastAddress property is no longer available for use as of Windows Server 2012.]

This property is not supported.

**Windows Server 2003: **

Provides the Class D IPv4 multicast address used for heartbeat multicasting on the network. The following table summarizes the attributes of the MulticastAddress property.

Attribute Value
Data type Null-terminated Unicode string
Access Read/write
Status Required
Structure CLUSPROP_SZ
Maximum None (but see Maximum Property Size.)
Default Varies

Remarks

Class D IPv4 addresses are in the range 224.0.0.0 to 239.255.255.255.

If the string is not a Class D IPv4 address, the current multicast configuration is deleted and the cluster attempts to obtain a new address. This means that the contents of the MulticastAddress, MulticastConfigType, MulticastLeaseExpires, MulticastLeaseObtained, MulticastLeaseRequestId, and MulticastLeaseServer properties are erased. The cluster service does not report an error when this occurs.

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 MulticastAddress can be set with the following example code:

WCHAR                szMulticastAddressData[] = L"239.255.0.0";
CLUSPROP_SZ_DECLARE( MulticastAddressValue, 
                     sizeof(szMulticastAddressData) / sizeof(WCHAR) );

MulticastAddressValue.Syntax.dw = CLUSPROP_SYNTAX_LIST_VALUE_SZ;
MulticastAddressValue.cbLength  = sizeof( szMulticastAddressData );
StringCbCopy( MulticastAddressValue.sz, 
              MulticastAddressValue.cbLength, 
              szMulticastAddressData );

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2003 Datacenter, Windows Server 2003 Enterprise
End of server support
Windows Server 2003 Datacenter, Windows Server 2003 Enterprise

See also

MulticastAddressRangeLower

MulticastAddressRangeUpper

MulticastConfigType

MulticastDisabled