IVsProjectSecrets.GetSecretAsync(String, CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.Embeddable.dll

Assembly:: Microsoft.VisualStudio.Shell.Framework.dll

Package:: Microsoft.VisualStudio.Shell.Framework v17.12.40391

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.

Gets the secret with the given name.

public System.Threading.Tasks.Task<string> GetSecretAsync (string name, System.Threading.CancellationToken cancellationToken = default);

abstract member GetSecretAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

Public Function GetSecretAsync (name As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of String)

Parameters

name: String

The name of the secret whose value should be retrieved. Must not be null or empty.

cancellationToken: CancellationToken

A token that may cancel this operation.

Returns

Task<String>

The value of the secret.

Exceptions

ArgumentNullException

Thrown if name is null.

ArgumentException

Thrown if name is empty.

KeyNotFoundException

Thrown if no secret with the specified name could be found.

UnauthorizedAccessException

Thrown when the user does not have permission for this operation.

IOException

Thrown when the operation could not be completed due to some network or I/O failure.

Applies to

Partager via