Uri.GetComponents Method (System)

.NET Framework Class Library

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)

Syntax

Visual Basic (Declaration)

Public Function GetComponents ( _
    components As UriComponents, _
    format As UriFormat _
) As String

Visual Basic (Usage)

Dim instance As Uri
Dim components As UriComponents
Dim format As UriFormat
Dim returnValue As String

returnValue = instance.GetComponents(components, _
    format)

public string GetComponents(
    UriComponents components,
    UriFormat format
)

Visual C++

public:
String^ GetComponents(
    UriComponents components, 
    UriFormat format
)

JScript

public function GetComponents(
    components : UriComponents, 
    format : UriFormat
) : String

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.

Exceptions

Exception	Condition
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.

Remarks

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.

Note:
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.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Reference

Uri Class

Uri Members

System Namespace