Share via


RegisterPrefix Method

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Registers a WebRequest descendant for the specified URI.

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

Syntax

'Declaration
Public Shared Function RegisterPrefix ( _
    prefix As String, _
    creator As IWebRequestCreate _
) As Boolean
public static bool RegisterPrefix(
    string prefix,
    IWebRequestCreate creator
)
public:
static bool RegisterPrefix(
    String^ prefix, 
    IWebRequestCreate^ creator
)
static member RegisterPrefix : 
        prefix:string * 
        creator:IWebRequestCreate -> bool 
public static function RegisterPrefix(
    prefix : String, 
    creator : IWebRequestCreate
) : boolean

Parameters

Return Value

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

Remarks

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.

Note

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 Security

See Also

Reference

WebRequest Class

System.Net Namespace