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

Asynchronously sends a WS-Trust Renew message to an endpoint.

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

Usage

'Usage
Dim instance As IWSTrustChannelContract
Dim request As RequestSecurityToken
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginRenew(request, callback, state)

Syntax

'Declaration
Function BeginRenew ( _
    request As RequestSecurityToken, _
    callback As AsyncCallback, _
    state As Object _
) As IAsyncResult

IAsyncResult BeginRenew (
    RequestSecurityToken request,
    AsyncCallback callback,
    Object state
)

IAsyncResult^ BeginRenew (
    RequestSecurityToken^ request, 
    AsyncCallback^ callback, 
    Object^ state
)

IAsyncResult BeginRenew (
    RequestSecurityToken request, 
    AsyncCallback callback, 
    Object state
)

function BeginRenew (
    request : RequestSecurityToken, 
    callback : AsyncCallback, 
    state : Object
) : IAsyncResult

Parameters

request
The RequestSecurityToken that represents the request to the STS.

callback
An optional AsyncCallback delegate, to be called when the send is complete.

state
A user-provided object that distinguishes this particular asynchronous send request from other requests.

Return Value

An IAsyncResult object that represents the asynchronous send, which could still be pending.

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)