Uri::GetComponents Method
Gets the specified components of the current instance using the specified escaping for special characters.
Assembly: System (in System.dll)
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.
| 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. |
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.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Note