WSFederationMessage.CreateFromNameValueCollection Method

Article
10/05/2012

[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 WS-Federation message from a NameValueCollection of parameters.

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

Usage

'Usage
Dim baseUrl As Uri
Dim collection As NameValueCollection
Dim returnValue As WSFederationMessage

returnValue = WSFederationMessage.CreateFromNameValueCollection(baseUrl, collection)

Syntax

'Declaration
Public Shared Function CreateFromNameValueCollection ( _
    baseUrl As Uri, _
    collection As NameValueCollection _
) As WSFederationMessage

public static WSFederationMessage CreateFromNameValueCollection (
    Uri baseUrl,
    NameValueCollection collection
)

public:
static WSFederationMessage^ CreateFromNameValueCollection (
    Uri^ baseUrl, 
    NameValueCollection^ collection
)

public static WSFederationMessage CreateFromNameValueCollection (
    Uri baseUrl, 
    NameValueCollection collection
)

public static function CreateFromNameValueCollection (
    baseUrl : Uri, 
    collection : NameValueCollection
) : WSFederationMessage

Parameters

baseUrl
The BaseUrl to which the message is intended.

collection
The NameValueCollection that contains the parameters for the message.

Return Value

A WSFederationMessage that represents the message or null if a message cannot be created.

Exceptions

Exception type	Condition
ArgumentNullException	baseUrl is null. -or- collection is null.
WSFederationMessageException	The Action (wa) parameter in the parameter collection is not recognized.
ArgumentException	A SignIn Response message has both the wresult and wresultptr parameter in the parameter collection.

ArgumentNullException

baseUrl is null.

-or-

collection is null.

WSFederationMessageException

The Action (wa) parameter in the parameter collection is not recognized.

ArgumentException

A SignIn Response message has both the wresult and wresultptr parameter in the parameter collection.

Remarks

The parameter collection must contain an entry for the Action (wa) parameter. In the base class an exception is thrown if this value does not correspond to one of the Action constants defined in the Actions class. The parameter collection should contain appropriate parameters for the kind of message specified by the Action (wa) parameter in the collection. The method will return an appropriate implementation of WSFederationMessage based on the Action (wa) parameter; for example, if the Action parameter is SignIn then a SignInRequestMessage message will be returned.

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)