Gets the stored credentials for the specified application, given a set of acceptable
credentials (Application, Default, etc.) and a preference as to which to try first.
Namespace: ININ.IceLib.ConnectionAssembly: ININ.IceLib (in ININ.IceLib.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public static StoredCredentials GetCredentials( string applicationName, LoadFlags acceptedCreds, LoadPreference preference ) |
Visual Basic |
---|
Public Shared Function GetCredentials ( _ applicationName As String, _ acceptedCreds As LoadFlags, _ preference As LoadPreference _ ) As StoredCredentials |
Parameters
- applicationName
- Type: System..::..String
The unique name of the application storing the credentials.
- acceptedCreds
- Type: ININ.IceLib.Connection..::..LoadFlags
One or more LoadFlags indicating which set of stored credentials are acceptable.
- preference
- Type: ININ.IceLib.Connection..::..LoadPreference
Used to specify the order in which to try and load the credentials.
Return Value
A StoredCredentials object from the specified set of accepted credentials, or nullNothingnullptra null reference (Nothing in Visual Basic) if there were no matches.Remarks
If Newest is specified, the system will retrieve the
most recently saved StoredCredentials object amongst those specified in acceptedCreds.
If Application is specified, the system will search for a set of stored
credentials using the following search order (records that are not indicated by acceptedCreds are ignored):
1. Credentials previously saved by the specified application.
2. The default set of stored credentials.
3. Any other stored credentials.
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | A parameter is nullNothingnullptra null reference (Nothing in Visual Basic). |
Version Information
Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.