WSFederationMessage.GetParameter Method

[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.]

Returns the specified parameter value from the parameters dictionary.

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

Usage

'Usage
Dim instance As WSFederationMessage
Dim parameter As String
Dim returnValue As String

returnValue = instance.GetParameter(parameter)

Syntax

'Declaration
Public Function GetParameter ( _
    parameter As String _
) As String
public string GetParameter (
    string parameter
)
public:
String^ GetParameter (
    String^ parameter
)
public String GetParameter (
    String parameter
)
public function GetParameter (
    parameter : String
) : String

Parameters

  • parameter
    The parameter for which to search.

Return Value

The value of the parameter or null if the parameter does not exist.

Exceptions

Exception type Condition
ArgumentException

parameter is null or an empty string.

Remarks

The parameters dictionary is accessed through the Parameters property.

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

WSFederationMessage Class
WSFederationMessage Members
Microsoft.IdentityModel.Protocols.WSFederation Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.