LocalSecureStoreProvider.GetCredentials method (String)

Article
10/19/2013

Gets the credentials associated with the specified target application identifier.

Namespace: Microsoft.Office.BusinessData.Infrastructure.SecureStore
Assembly: Microsoft.Office.BusinessData (in Microsoft.Office.BusinessData.dll)

Syntax

'Declaration
Public Function GetCredentials ( _
    appId As String _
) As SecureStoreCredentialCollection
'Usage
Dim instance As LocalSecureStoreProvider
Dim appId As String
Dim returnValue As SecureStoreCredentialCollection

returnValue = instance.GetCredentials(appId)

public SecureStoreCredentialCollection GetCredentials(
    string appId
)

Parameters

appId
Type: System.String

The target application identifier.

Return value

Type: Microsoft.BusinessData.Infrastructure.SecureStore.SecureStoreCredentialCollection
The credential collection.

Implements

ISecureStoreProvider.GetCredentials(String)

Exceptions

Exception	Condition
SecureStoreTargetApplicationNotFoundException	If a user clicks Cancel on the Windows Credentials Manager dialog that is displayed to enter credentials for a target application.

Remarks

This call prompts the user to enter the credentials if the credentials are not already set. So for the first usage, the user is prompted to enter the credentials and for subsequent calls the credentials are retrieved from the Windows credential store.