This topic has not yet been rated - Rate this topic

WebRequest.RegisterPrefix Method

Registers a WebRequest descendant for the specified URI.

Namespace:  System.Net
Assembly:  System (in System.dll)
'Declaration
Public Shared Function RegisterPrefix ( _
	prefix As String, _
	creator As IWebRequestCreate _
) As Boolean

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 Nothing

-or-

creator is Nothing.

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.5, 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

.NET for Windows Store apps

Supported in: Windows 8

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.