WSFederationMessage.TryCreateFromUri Method

2012-10-05

[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 as a query string.

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

Usage

'Usage
Dim requestUri As Uri
Dim fedMsg As WSFederationMessage
Dim returnValue As Boolean

returnValue = WSFederationMessage.TryCreateFromUri(requestUri, fedMsg)

Syntax

'Declaration
Public Shared Function TryCreateFromUri ( _
    requestUri As Uri, _
    <OutAttribute> ByRef fedMsg As WSFederationMessage _
) As Boolean

public static bool TryCreateFromUri (
    Uri requestUri,
    out WSFederationMessage fedMsg
)

public:
static bool TryCreateFromUri (
    Uri^ requestUri, 
    [OutAttribute] WSFederationMessage^% fedMsg
)

public static boolean TryCreateFromUri (
    Uri requestUri, 
    /** @attribute OutAttribute() */ /** @ref */ WSFederationMessage fedMsg
)

Parameters

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

fedMsg
A WSFederationMessage that contains the created message when this method returns or is null if a message could not be created. This parameter is passed uninitialized.

Return Value

true if a message was successfully created; otherwise false.

Exceptions

Exception type	Condition
ArgumentNullException	requestUri is null.

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)

Share via