DistributedCacheExtensions.SetStringAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| SetStringAsync(IDistributedCache, String, String, CancellationToken) |
Asynchronously sets a string in the specified cache with the specified key. |
| SetStringAsync(IDistributedCache, String, String, DistributedCacheEntryOptions, CancellationToken) |
Asynchronously sets a string in the specified cache with the specified key. |
SetStringAsync(IDistributedCache, String, String, CancellationToken)
Asynchronously sets a string in the specified cache with the specified key.
public static System.Threading.Tasks.Task SetStringAsync (this Microsoft.Extensions.Caching.Distributed.IDistributedCache cache, string key, string value, System.Threading.CancellationToken token = default);static member SetStringAsync : Microsoft.Extensions.Caching.Distributed.IDistributedCache * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Extension()>
Public Function SetStringAsync (cache As IDistributedCache, key As String, value As String, Optional token As CancellationToken = Nothing) As TaskParameters
- cache
- IDistributedCache
The cache in which to store the data.
- key
- String
The key to store the data in.
- value
- String
The data to store in the cache.
- token
- CancellationToken
Optional. A CancellationToken to cancel the operation.
Returns
A task that represents the asynchronous set operation.
Exceptions
The cancellation token was canceled. This exception is stored into the returned task.
key or value is null.
Remarks
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by SetString(IDistributedCache, String, String).
Applies to
SetStringAsync(IDistributedCache, String, String, DistributedCacheEntryOptions, CancellationToken)
Asynchronously sets a string in the specified cache with the specified key.
public static System.Threading.Tasks.Task SetStringAsync (this Microsoft.Extensions.Caching.Distributed.IDistributedCache cache, string key, string value, Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions options, System.Threading.CancellationToken token = default);static member SetStringAsync : Microsoft.Extensions.Caching.Distributed.IDistributedCache * string * string * Microsoft.Extensions.Caching.Distributed.DistributedCacheEntryOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Extension()>
Public Function SetStringAsync (cache As IDistributedCache, key As String, value As String, options As DistributedCacheEntryOptions, Optional token As CancellationToken = Nothing) As TaskParameters
- cache
- IDistributedCache
The cache in which to store the data.
- key
- String
The key to store the data in.
- value
- String
The data to store in the cache.
- options
- DistributedCacheEntryOptions
The cache options for the entry.
- token
- CancellationToken
Optional. A CancellationToken to cancel the operation.
Returns
A task that represents the asynchronous set operation.
Exceptions
The cancellation token was canceled. This exception is stored into the returned task.
key or value is null.
Remarks
This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by SetString(IDistributedCache, String, String, DistributedCacheEntryOptions).
