WSFederationMessage.CreateFromUri 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.]

Helper method to create a WS-Federation message from a URI. The parameters are assumed to be specified in the query string.

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

Usage

'Usage
Dim requestUri As Uri
Dim returnValue As WSFederationMessage

returnValue = WSFederationMessage.CreateFromUri(requestUri)

Syntax

'Declaration
Public Shared Function CreateFromUri ( _
    requestUri As Uri _
) As WSFederationMessage

public static WSFederationMessage CreateFromUri (
    Uri requestUri
)

public:
static WSFederationMessage^ CreateFromUri (
    Uri^ requestUri
)

public static WSFederationMessage CreateFromUri (
    Uri requestUri
)

public static function CreateFromUri (
    requestUri : Uri
) : WSFederationMessage

Parameters

requestUri
The URI from which to create the message. Message parameters are specified in the query string.

Return Value

A WSFederationMessage that represents the message.

Exceptions

Exception type	Condition
ArgumentNullException	requestUri is null.
WSFederationMessageException	The message cannot be created.

Remarks

The method returns an appropriate implementation of WSFederationMessage based on the wa parameter in the query string; for example, if wa parameter is "wsignin1.0" then a SignInRequestMessage object is returned.

Other exceptions may be thrown depending on the combination and values of parameters present in the query string.

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)