Edit

DistributedCacheExtensions.SetAsync Method

  • Reference

Definition

Namespace:
Microsoft.Extensions.Caching.Distributed
Assembly:
Microsoft.Extensions.Caching.Abstractions.dll
Package:
Microsoft.Extensions.Caching.Abstractions v6.0.0
Package:
Microsoft.Extensions.Caching.Abstractions v7.0.0
Package:
Microsoft.Extensions.Caching.Abstractions v8.0.0
Package:
Microsoft.Extensions.Caching.Abstractions v9.0.0-preview.2.24128.5

Overloads

SetAsync(IDistributedCache, String, Byte[])

Asynchronously sets a sequence of bytes in the specified cache with the specified key.
SetAsync(IDistributedCache, String, Byte[], CancellationToken)

Asynchronously sets a sequence of bytes in the specified cache with the specified key.

SetAsync(IDistributedCache, String, Byte[])

Asynchronously sets a sequence of bytes in the specified cache with the specified key.

public:
[System::Runtime::CompilerServices::Extension]
 static System::Threading::Tasks::Task ^ SetAsync(Microsoft::Extensions::Caching::Distributed::IDistributedCache ^ cache, System::String ^ key, cli::array <System::Byte> ^ value);
public static System.Threading.Tasks.Task SetAsync (this Microsoft.Extensions.Caching.Distributed.IDistributedCache cache, string key, byte[] value);
static member SetAsync : Microsoft.Extensions.Caching.Distributed.IDistributedCache * string * byte[] -> System.Threading.Tasks.Task
<Extension()>
Public Function SetAsync (cache As IDistributedCache, key As String, value As Byte()) As Task

Parameters

cache
IDistributedCache

The cache in which to store the data.

key
String

The key to store the data in.

value
Byte[]

The data to store in the cache.

Returns

Task

A task that represents the asynchronous set operation.

Exceptions

ArgumentNullException

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 Set(IDistributedCache, String, Byte[]).

Applies to

SetAsync(IDistributedCache, String, Byte[], CancellationToken)

Source:
DistributedCacheExtensions.cs
Source:
DistributedCacheExtensions.cs
Source:
DistributedCacheExtensions.cs

Asynchronously sets a sequence of bytes in the specified cache with the specified key.

public static System.Threading.Tasks.Task SetAsync (this Microsoft.Extensions.Caching.Distributed.IDistributedCache cache, string key, byte[] value, System.Threading.CancellationToken token = default);
static member SetAsync : Microsoft.Extensions.Caching.Distributed.IDistributedCache * string * byte[] * System.Threading.CancellationToken -> System.Threading.Tasks.Task
<Extension()>
Public Function SetAsync (cache As IDistributedCache, key As String, value As Byte(), Optional token As CancellationToken = Nothing) As Task

Parameters

cache
IDistributedCache

The cache in which to store the data.

key
String

The key to store the data in.

value
Byte[]

The data to store in the cache.

token
CancellationToken

Optional. A CancellationToken to cancel the operation.

Returns

Task

A task that represents the asynchronous set operation.

Exceptions

ArgumentNullException

key or value is null.

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

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 Set(IDistributedCache, String, Byte[]).

Applies to