WSFederationMessage.TryCreateFromUri(Uri, WSFederationMessage) Method

Reference

Definition

Namespace:: System.IdentityModel.Services

Assembly:: System.IdentityModel.Services.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Attempts to create a WS-Federation message from the specified URI. The parameters are assumed to be specified as a query string.

public:
 static bool TryCreateFromUri(Uri ^ requestUri, [Runtime::InteropServices::Out] System::IdentityModel::Services::WSFederationMessage ^ % fedMsg);

public static bool TryCreateFromUri (Uri requestUri, out System.IdentityModel.Services.WSFederationMessage fedMsg);

static member TryCreateFromUri : Uri * WSFederationMessage -> bool

Public Shared Function TryCreateFromUri (requestUri As Uri, ByRef fedMsg As WSFederationMessage) As Boolean

Parameters

requestUri: Uri

The URI from which to create the message. Message parameters are specified in the query string. The wa parameter must be present.

fedMsg: WSFederationMessage

When this method returns, contains the message that was created or null if a message could not be created. This parameter is treated as uninitialized.

Returns

Boolean

true if a message was successfully created; otherwise, false.

Exceptions

ArgumentNullException

requestUri is null.

Remarks

If a message can be created, the method returns an appropriate implementation of WSFederationMessage based on the wa parameter in the query string; for example, if wa parameter is "wsignout1.0" then a SignOutRequestMessage object is returned.

Invokes the CreateFromNameValueCollection method.

Applies to