Uri.IsWellFormedUriString(String, UriKind) Method

Reference

Definition

Namespace:: System

Assembly:: System.Runtime.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: UriExt.cs

Source:: UriExt.cs

Source:: UriExt.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.

Indicates whether the string is well-formed by attempting to construct a URI with the string and ensures that the string does not require further escaping.

public:
 static bool IsWellFormedUriString(System::String ^ uriString, UriKind uriKind);

public static bool IsWellFormedUriString (string uriString, UriKind uriKind);

public static bool IsWellFormedUriString (string? uriString, UriKind uriKind);

static member IsWellFormedUriString : string * UriKind -> bool

Public Shared Function IsWellFormedUriString (uriString As String, uriKind As UriKind) As Boolean

Parameters

uriString: String

The string used to attempt to construct a Uri.

uriKind: UriKind

The type of the Uri in uriString.

Returns

Boolean

true if the string was well-formed; otherwise, false.

Remarks

In versions of .NET before version 4.5, by default the string is considered well-formed in accordance with RFC 2396 and RFC 2732. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing are enabled, the string is considered well-formed in accordance with RFC 3986 and RFC 3987.

Beginning in .NET 4.5, strings are always considered well-formed in accordance with RFC 3986 and RFC 3987, whether or not IRI or IDN are enabled. Note, however, that this is only true for apps that target .NET 4.5 or later. Apps that target .NET 4.0 invoke compatibility code, and experience the old (pre-4.5) behavior.

The string is considered poorly formed, causing the method to return false, if any of the following conditions occur

Error	Example
The string is not correctly escaped.	`http://www.contoso.com/path???/file name`
The string is an absolute Uri that represents an implicit file Uri.	`c:\\directory\filename`
The string is an absolute URI that is missing a slash before the path.	`file://c:/directory/filename`
The string contains unescaped backslashes even if they will be treated as forward slashes	`http:\\\host/path/file`
The string represents a hierarchical absolute Uri and does not contain "://"	`www.contoso.com/path/file`
The parser for the Scheme indicates that the original string was not well-formed.	The example depends on the scheme of the URI.
Beginning with .NET 4.5, relative URIs with a colon (':') in their first segment are not considered well-formed.	`2013.05.29_14:33:41`

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

Applies to

Jaa