ChannelFactoryOperations.CreateChannelWithParameters Method (ChannelFactory, EndpointAddress, FederatedClientCredentialsParameters)

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Creates a channel of a specified type to a specified endpoint that will utilize the provided FederatedClientCredentialsParameters object to customize token issuance behavior.

Namespace: Microsoft.IdentityModel.Protocols.WSTrust
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim factory As ChannelFactory(Of T)
Dim address As EndpointAddress
Dim parameters As FederatedClientCredentialsParameters
Dim returnValue As T

returnValue = ChannelFactoryOperations.CreateChannelWithParameters(factory, address, parameters)

Syntax

'Declaration
Public Shared Function CreateChannelWithParameters(Of T) ( _
    factory As ChannelFactory(Of T), _
    address As EndpointAddress, _
    parameters As FederatedClientCredentialsParameters _
) As T
public static T CreateChannelWithParameters<T> (
    ChannelFactory<T> factory,
    EndpointAddress address,
    FederatedClientCredentialsParameters parameters
)
public:
generic<typename T>
static T CreateChannelWithParameters (
    ChannelFactory<T>^ factory, 
    EndpointAddress^ address, 
    FederatedClientCredentialsParameters^ parameters
)

GenericParameters

  • T
    The type of channel produced by the channel factory.

Parameters

  • factory
    The channel factory used to create the channel.
  • parameters
    The FederatedClientCredentialsParameters that contains settings that either provide an issued token to use to secure the channel or provide additional security tokens that augment the WS-Trust RequestSecurityToken messages sent.

Return Value

The IChannelof type T created by the factory.

Exceptions

Exception type Condition
ArgumentNullException

channelFactory is null.

InvalidOperationException

The channel factory specified by factory was not configured already by calling the factory.ConfigureChannelFactory method.

Remarks

Creates a channel of type T, the generic parameter for the method.

You must call the factory.ConfigureChannelFactory method prior to calling this method.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)

See Also

Reference

ChannelFactoryOperations Class
ChannelFactoryOperations Members
Microsoft.IdentityModel.Protocols.WSTrust Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.