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

When overridden in a derived class, begins an asynchronous WS-Trust Cancel request.

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

Usage

'Usage
Dim instance As SecurityTokenService
Dim principal As IClaimsPrincipal
Dim request As RequestSecurityToken
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginCancel(principal, request, callback, state)

Syntax

'Declaration
Public Overridable Function BeginCancel ( _
    principal As IClaimsPrincipal, _
    request As RequestSecurityToken, _
    callback As AsyncCallback, _
    state As Object _
) As IAsyncResult

public virtual IAsyncResult BeginCancel (
    IClaimsPrincipal principal,
    RequestSecurityToken request,
    AsyncCallback callback,
    Object state
)

public:
virtual IAsyncResult^ BeginCancel (
    IClaimsPrincipal^ principal, 
    RequestSecurityToken^ request, 
    AsyncCallback^ callback, 
    Object^ state
)

public IAsyncResult BeginCancel (
    IClaimsPrincipal principal, 
    RequestSecurityToken request, 
    AsyncCallback callback, 
    Object state
)

public function BeginCancel (
    principal : IClaimsPrincipal, 
    request : RequestSecurityToken, 
    callback : AsyncCallback, 
    state : Object
) : IAsyncResult

Parameters

principal
An IClaimsPrincipal that represents the identity of the token requestor.

request
A RequestSecurityToken that represents the security token request. This includes the request message as well as other client related information such as authorization context.

callback
The AsynchCallback delegate that receives notification of the completion of the asynchronous cancel operation.

state
An object that contains state information associated with the asynchronous cancel operation.

Return Value

The IAsyncResult that references the asynchronous cancel operation.

Remarks

The default implementation of this method throws an InvalidRequestException.

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)