Article
11/18/2011

UriParser.GetComponents Method

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

Gets the components from a URI.

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

Syntax

'Declaration
Protected Overridable Function GetComponents ( _
    uri As Uri, _
    components As UriComponents, _
    format As UriFormat _
) As String

protected virtual string GetComponents(
    Uri uri,
    UriComponents components,
    UriFormat format
)

Parameters

uri
Type: System.Uri
The Uri to parse.

components
Type: System.UriComponents
The UriComponents to retrieve from uri.

format
Type: System.UriFormat
One of the UriFormat values that controls how special characters are escaped.

Return Value

Type: System.String
A string that contains the components.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	format is invalid - or - components is not a combination of valid UriComponents values.
InvalidOperationException	uri requires user-driven parsing - or - uri is not an absolute URI. Relative URIs cannot be used with this method.

ArgumentOutOfRangeException

format is invalid

- or -

components is not a combination of valid UriComponents values.

InvalidOperationException

uri requires user-driven parsing

- or -

uri is not an absolute URI. Relative URIs cannot be used with this method.

Remarks

Use the GetComponents method to determine the value of various parts of the URI, such as the Scheme, Host, or Port.

The components are returned in the order that they appear in the URI. For example, if Scheme is specified, it appears first.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

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