IPAddress.ScopeId Property

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Gets or sets the IPv6 address scope identifier.

Namespace:  System.Net
Assembly:  System.Net (in System.Net.dll)

Syntax

'Declaration
Public Property ScopeId As Long
public long ScopeId { get; set; }

Property Value

Type: System.Int64
A long integer that specifies the scope of the address.

Exceptions

Exception Condition
ArgumentOutOfRangeException

The value when setting the ScopeId is less than 0 or

the value is greater than 0x00000000FFFFFFFF.

SocketException

The AddressFamily property is specified as InterNetwork.

Remarks

The meaning of ScopeId changes depending on the context in which it is used.

  • Link-local address. On a host with multiple interfaces connected to separate links, the same link-local address can be assigned to multiple interfaces. To eliminate this ambiguity, a scope identifier is used to specify the interface over which messages are exchanged.
NoteNote:

Link-local addresses, identified by the Format Prefix (FP) FE80, are used by nodes when communicating with neighboring nodes on the same link.

  • Site-local addresses. A host can be connected to multiple sites. In this case, a scope identifier is used to indicate a specific site to communicate with.
NoteNote:

Site-local addresses, identified by the Format Prefix (FP) FEC0, are used by nodes when communicating on private intranets.

The notation that is used to specify the ScopeId with an address is Address%ScopeId. For example, FE80::5EFE:192.168.41.30%2.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.