Export (0) Print
Expand All

FtpWebRequest.ConnectionGroupName Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets the name of the connection group that contains the service point used to send the current request.

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

public override string ConnectionGroupName { get; set; }
/** @property */
public String get_ConnectionGroupName ()

/** @property */
public void set_ConnectionGroupName (String value)

public override function get ConnectionGroupName () : String

public override function set ConnectionGroupName (value : String)

Property Value

A String value that contains a connection group name.

Exception typeCondition

InvalidOperationException

A new value was specified for this property for a request that is already in progress.

Connection groups associate a set of requests with a particular connection or set of connections. The connections in a connection group can be reused only by requests originating in the same application domain, when the credentials on the request are the same and the request specifies the connection group name. When a request does not specify a connection group name, any existing connection to the requested server that is not associated with a connection group can be used. When the credentials are not the same, the existing connection is closed and the new request must be reauthenticated.

Using connection groups can improve performance because this allows all of the requests for a user to reuse the connection authenticated with the user's credentials.

Changing the ConnectionGroupName property after calling the GetRequestStream, BeginGetRequestStream, GetResponse, or BeginGetResponse method causes an InvalidOperationException exception.

The following code example retrieves the value of this property.

IWebProxy proxy = request.Proxy;
if (proxy != null)
{
    Console.WriteLine("Proxy: {0}", proxy.GetProxy(request.RequestUri));
} 
else
{
    Console.WriteLine("Proxy: (none)");
}

Console.WriteLine("ConnectionGroup: {0}",
    request.ConnectionGroupName == null ? "none" : request.ConnectionGroupName
);

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2015 Microsoft