The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

SecurityTokenProvider::GetToken Method (TimeSpan)

.NET Framework (current version)

Other Versions

Gets a security token.

Namespace: System.IdentityModel.Selectors
Assembly: System.IdentityModel (in System.IdentityModel.dll)

Syntax

C++

public:
SecurityToken^ GetToken(
	TimeSpan timeout
)

Parameters

timeout: Type: System::TimeSpan
A TimeSpan that specifies the timeout value for the message that gets the security token.

Return Value

Type: System.IdentityModel.Tokens::SecurityToken^

The SecurityToken that represents the security token to get.

Remarks

The GetToken method is called by the ClientCredentials class when a client sends a SOAP message and a security token is required.

The GetToken method calls the GetTokenCore method.

In most cases the timeout parameter is not used by derived classes of SecurityTokenProvider such as UserNameSecurityTokenProvider. However, sometimes retrieving a security token involves distributed messaging. An example is IssuedSecurityTokenProvider used in a federated service. In these cases the timeout parameter is used to avoid exceptions caused by network failures, message loss, and other error conditions.

Version Information

.NET Framework
Available since 3.0