Export (0) Print
Expand All

Uri.GetComponents Method

Gets the specified components of the current instance using the specified escaping for special characters.

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

public string GetComponents(
	UriComponents components,
	UriFormat format
)

Parameters

components
Type: System.UriComponents

A bitwise combination of the UriComponents values that specifies which parts of the current instance to return to the caller.

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.

ExceptionCondition
ArgumentOutOfRangeException

uriComponents is not a combination of valid UriComponents values.

InvalidOperationException

The current Uri is not an absolute URI. Relative URIs cannot be used with this method.

When Query or Fragment is specified alone, the return value includes the delimiter. The Scheme, UserInfo, Host, Port, and Path components do not include the delimiter. For all other UriComponents values, and combinations of values, the delimiters are included in the returned value.

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

When International Resource Identifier (IRI) and Internationalized Domain Name (IDN) support are enabled, the number of characters returned in the String increases. Punycode names used to support IRI contain only ASCII characters and always start with the xn-- prefix. When IRI and IDN are enabled, Unicode surrogate characters are handled correctly by the GetComponents method.

For more information on IRI support, see the Remarks section for the Uri class.

NoteNote

If the GetComponents method is called with format set to Unescaped , you cannot use the return value as an argument to a Uri constructor to create an equivalent Uri.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft