WSTrustMessage.UseKey Property

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

Gets or sets the contents of the wst:UseKey element.

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

Usage

'Usage
Dim instance As WSTrustMessage
Dim value As UseKey

value = instance.UseKey

instance.UseKey = value

Syntax

'Declaration
Public Property UseKey As UseKey

public UseKey UseKey { get; set; }

public:
property UseKey^ UseKey {
    UseKey^ get ();
    void set (UseKey^ value);
}

/** @property */
public UseKey get_UseKey ()

/** @property */
public void set_UseKey (UseKey value)

public function get UseKey () : UseKey

public function set UseKey (value : UseKey)

Property Value

A UseKey that contains the key.

Remarks

If the requestor wishes to use an existing key rather than create a new one, then this property can be used to reference a security token containing the desired key. This is commonly used in the asymetric key issurance case.

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)