UriParser.GetComponents(Uri, UriComponents, UriFormat) Method

Reference

Definition

Namespace:: System

Assembly:: System.Runtime.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: UriScheme.cs

Source:: UriScheme.cs

Source:: UriScheme.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the components from a URI.

protected:
 virtual System::String ^ GetComponents(Uri ^ uri, UriComponents components, UriFormat format);

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

abstract member GetComponents : Uri * UriComponents * UriFormat -> string
override this.GetComponents : Uri * UriComponents * UriFormat -> string

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

Parameters

uri: Uri

The URI to parse.

components: UriComponents

The UriComponents to retrieve from uri.

format: UriFormat

One of the UriFormat values that controls how special characters are escaped.

Returns

String

A string that contains the components.

Exceptions

ArgumentOutOfRangeException

uriFormat is invalid.

-or-

uriComponents 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.

Applies to