WebRequest.RegisterPrefix Method

Registers a WebRequest descendant for the specified URI.

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

public static bool RegisterPrefix(
	string prefix,
	IWebRequestCreate creator
)

Parameters

prefix
Type: System.String
The complete URI or URI prefix that the WebRequest descendant services.
creator
Type: System.Net.IWebRequestCreate
The create method that the WebRequest calls to create the WebRequest descendant.

Return Value

Type: System.Boolean
true if registration is successful; otherwise, false.

ExceptionCondition
ArgumentNullException

prefix is null

-or-

creator is null.

The RegisterPrefix method registers WebRequest descendants to service requests. WebRequest descendants are typically registered to handle a specific protocol, such HTTP or FTP, but can be registered to handle a request to a specific server or path on a server.

The pre-registered reserve types already registered include the following:

  • http://

  • https://

  • ftp://

  • file://

For more information, see the Create(String) and Create(Uri) methods.

Duplicate prefixes are not allowed. RegisterPrefix returns false if an attempt is made to register a duplicate prefix.

NoteNote

The HttpWebRequest class is registered to service requests for HTTP and HTTPS schemes by default. Attempts to register a different WebRequest descendant for these schemes will fail.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2015 Microsoft