HttpWebRequest.ConnectionGroupName Property (System.Net)

Switch View :
ScriptFree
.NET Framework Class Library
HttpWebRequest.ConnectionGroupName Property

Gets or sets the name of the connection group for the request.

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

Visual Basic
Public Overrides Property ConnectionGroupName As String
C#
public override string ConnectionGroupName { get; set; }
Visual C++
public:
virtual property String^ ConnectionGroupName {
	String^ get () override;
	void set (String^ value) override;
}
F#
abstract ConnectionGroupName : string with get, set
override ConnectionGroupName : string with get, set

Property Value

Type: System.String
The name of the connection group for this request. The default value is null.
Remarks

The ConnectionGroupName property enables you to associate a request with a connection group. This is useful when your application makes requests to one server for different users, such as a Web site that retrieves customer information from a database server.

Notes to Implementers

Each connection group creates additional connections for a server. This may result in exceeding the number of connections set by the ServicePoint.ConnectionLimit property for that server.

Examples

The following code example show how to use user information to form a connection group, assuming that the variables username, password, and domain are set by the application before this code is called.

Visual Basic

' Create a secure group name.
Dim Sha1 As New SHA1Managed()
Dim updHash As [Byte]() = Sha1.ComputeHash(Encoding.UTF8.GetBytes(("username" + "password" + "domain")))
Dim secureGroupName As [String] = Encoding.Default.GetString(updHash)

' Create a request for a specific URL.
Dim myWebRequest As WebRequest = WebRequest.Create("http://www.contoso.com")

' Set the authentication credentials for the request.      
myWebRequest.Credentials = New NetworkCredential("username", "password", "domain")
myWebRequest.ConnectionGroupName = secureGroupName

' Get the response.
Dim myWebResponse As WebResponse = myWebRequest.GetResponse()

' Insert the code that uses myWebResponse here.
' Close the response.
myWebResponse.Close()
   


C#

// Create a secure group name.
SHA1Managed Sha1 = new SHA1Managed();
Byte[] updHash = Sha1.ComputeHash(Encoding.UTF8.GetBytes("username" + "password" +  "domain"));
String secureGroupName = Encoding.Default.GetString(updHash);

// Create a request for a specific URL.
WebRequest myWebRequest=WebRequest.Create("http://www.contoso.com");

// Set the authentication credentials for the request.      
myWebRequest.Credentials = new NetworkCredential("username", "password", "domain"); 
myWebRequest.ConnectionGroupName = secureGroupName;

// Get the response.
WebResponse myWebResponse=myWebRequest.GetResponse();

// Insert the code that uses myWebResponse here.

// Close the response.
myWebResponse.Close();
    


Visual C++

// Create a secure group name.
SHA1Managed^ Sha1 = gcnew SHA1Managed;
array<Byte>^updHash = Sha1->ComputeHash( Encoding::UTF8->GetBytes( "usernamepassworddomain" ) );
String^ secureGroupName = Encoding::Default->GetString( updHash );

// Create a request for a specific URL.
WebRequest^ myWebRequest = WebRequest::Create( "http://www.contoso.com" );

// Set the authentication credentials for the request.      
myWebRequest->Credentials = gcnew NetworkCredential( "username","password","domain" );
myWebRequest->ConnectionGroupName = secureGroupName;

// Get the response.
WebResponse^ myWebResponse = myWebRequest->GetResponse();

// Insert the code that uses myWebResponse here.
// Close the response.
myWebResponse->Close();


Version Information

.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
Platforms

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.
See Also

Reference

Other Resources