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

Sets the new subject for the claim.

Namespace: Microsoft.IdentityModel.Claims
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As Claim
Dim subject As IClaimsIdentity

instance.SetSubject(subject)

Syntax

'Declaration
Public Overridable Sub SetSubject ( _
    subject As IClaimsIdentity _
)
public virtual void SetSubject (
    IClaimsIdentity subject
)
public:
virtual void SetSubject (
    IClaimsIdentity^ subject
)
public void SetSubject (
    IClaimsIdentity subject
)
public function SetSubject (
    subject : IClaimsIdentity
)

Parameters

Remarks

This method is not called directly. Instead, it is called by implementations of the ClaimCollection class when claims are added to one of the IClaimsIdentity objects contained in the collection. This method ensures that the IClaimsIdentity to which the claim is being added is set as the subject of the claim.

Important

This method should only be called by ClaimCollection implementations - these are responsible for maintaining the referential integrity of the Subject 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)

Change History

See Also

Reference

Claim Class
Claim Members
Microsoft.IdentityModel.Claims Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.