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

Sets the value of a parameter in 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 value As String

instance.SetParameter(parameter, value)

Syntax

'Declaration
Public Sub SetParameter ( _
    parameter As String, _
    value As String _
)

public void SetParameter (
    string parameter,
    string value
)

public:
void SetParameter (
    String^ parameter, 
    String^ value
)

public void SetParameter (
    String parameter, 
    String value
)

public function SetParameter (
    parameter : String, 
    value : String
)

Parameters

parameter
The name of the parameter to set.

value
The value to be assigned to the parameter.

Exceptions

Exception type	Condition
ArgumentException	parameter is null. -or- value is null.

ArgumentException

parameter is null.

-or-

value is null.

Remarks

Typically, the name of the parameter corresponds to one of the constants in the Parameters class. If the parameter does not exist in the dictionary, it is added to it. 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)