Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

ICredentials.GetCredential Method

Returns a NetworkCredential object that is associated with the specified URI, and authentication type.

Namespace: System.Net
Assembly: System (in system.dll)

'Declaration
Function GetCredential ( _
	uri As Uri, _
	authType As String _
) As NetworkCredential
'Usage
Dim instance As ICredentials
Dim uri As Uri
Dim authType As String
Dim returnValue As NetworkCredential

returnValue = instance.GetCredential(uri, authType)
NetworkCredential GetCredential (
	Uri uri, 
	String authType
)
function GetCredential (
	uri : Uri, 
	authType : String
) : NetworkCredential

Parameters

uri

The Uri that the client is providing authentication for.

authType

The type of authentication, as defined in the IAuthenticationModule.AuthenticationType property.

Return Value

The NetworkCredential that is associated with the specified URI and authentication type, or, if no credentials are available, a null reference (Nothing in Visual Basic).

The GetCredential method returns a NetworkCredential instance that contains the credentials that are associated with the specified URI and authorization scheme. When no credentials are available, the GetCredential method returns a null reference (Nothing in Visual Basic).

The following uses GetCredential to retrieve a NetworkCredential instance.

       
Class CredentialInfo
    Public uriObj As Uri
    Public authenticationType As [String]
    Public networkCredentialObj As NetworkCredential
    
    
    Public Sub New(uriObj As Uri, authenticationType As [String], networkCredentialObj As NetworkCredential)
        Me.uriObj = uriObj
        Me.authenticationType = authenticationType
        Me.networkCredentialObj = networkCredentialObj
    End Sub 'New
End Class 'CredentialInfo

Private arrayListObj As ArrayList


Public Sub New()
    arrayListObj = New ArrayList()
End Sub 'New


Public Sub Add(uriObj As Uri, authenticationType As [String], credential As NetworkCredential)
    ' adds a 'CredentialInfo' object into a list
    arrayListObj.Add(New CredentialInfo(uriObj, authenticationType, credential))
End Sub 'Add

' Remove the 'CredentialInfo' object from the list which matches to the given 'Uri' and 'AuthenticationType'
Public Sub Remove(uriObj As Uri, authenticationType As [String])
    Dim index As Integer
    For index = 0 To arrayListObj.Count - 1
        Dim credentialInfo As CredentialInfo = CType(arrayListObj(index), CredentialInfo)
        If uriObj.Equals(credentialInfo.uriObj) And authenticationType.Equals(credentialInfo.authenticationType) Then
            arrayListObj.RemoveAt(index)
        End If
    Next index
End Sub 'Remove

Public Function GetCredential(uriObj As Uri, authenticationType As [String]) As NetworkCredential  Implements ICredentials.GetCredential
    Dim index As Integer
    For index = 0 To arrayListObj.Count - 1
        Dim credentialInfoObj As CredentialInfo = CType(arrayListObj(index), CredentialInfo)
        If uriObj.Equals(credentialInfoObj.uriObj) And authenticationType.Equals(credentialInfoObj.authenticationType) Then
            Return credentialInfoObj.networkCredentialObj
        End If
    Next index
    Return Nothing
End Function 'GetCredential

class CredentialList implements ICredentials
{
    class CredentialInfo
    {
        public Uri uriObj;
        public String authenticationType;
        public NetworkCredential networkCredentialObj;

        public CredentialInfo(Uri uriObj, String authenticationType, 
            NetworkCredential networkCredentialObj)
        {
            this.uriObj = uriObj;
            this.authenticationType = authenticationType;
            this.networkCredentialObj = networkCredentialObj;
        } //CredentialInfo
    } //CredentialInfo

    private ArrayList arrayListObj;

    public CredentialList()
    {
        arrayListObj = new ArrayList();
    } //CredentialList

    public void Add(Uri uriObj, String authenticationType, 
        NetworkCredential credential)
    {
        // Add a 'CredentialInfo' object into a list.
        arrayListObj.Add(new CredentialInfo(uriObj, 
            authenticationType, credential));
    } //Add

    // Remove the 'CredentialInfo' object from the list that matches to 
    // the given 'Uri' and 'AuthenticationType'
    public void Remove(Uri uriObj, String authenticationType)
    {
        for (int index = 0; index < arrayListObj.get_Count(); index++) {
            CredentialInfo credentialInfo = (CredentialInfo)
                arrayListObj.get_Item(index);

            if (uriObj.Equals(credentialInfo.uriObj) && 
                authenticationType.Equals(credentialInfo.authenticationType)) {
                arrayListObj.RemoveAt(index);
            }
        }
    } //Remove

    public NetworkCredential GetCredential(Uri uriObj, 
        String authenticationType)
    {
        for (int index = 0; index < arrayListObj.get_Count(); index++) {
            CredentialInfo credentialInfoObj = (CredentialInfo)
                arrayListObj.get_Item(index);

            if (uriObj.Equals(credentialInfoObj.uriObj) && 
                authenticationType.Equals(credentialInfoObj.
                authenticationType)) {
                return credentialInfoObj.networkCredentialObj;
            }
        }
        return null;
    } //GetCredential
} //CredentialList

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.