0 out of 1 rated this helpful - Rate this topic

ICredentials.GetCredential Method

.NET Framework 3.0

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

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

NetworkCredential GetCredential (
	Uri uri,
	string authType
)

NetworkCredential GetCredential (
	Uri uri, 
	String authType
)

JScript

function GetCredential (
	uri : Uri, 
	authType : String
) : NetworkCredential

XAML

Not applicable.

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).

Remarks

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).

Example

The following uses GetCredential to retrieve a NetworkCredential instance.

C++

class CredentialList : 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;
        }
    }

    private ArrayList arrayListObj;

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

    public void Add (Uri uriObj, String authenticationType, NetworkCredential credential)
    {
        // Add a 'CredentialInfo' object into a list.
        arrayListObj.Add (new CredentialInfo(uriObj, authenticationType, credential));      
    }
    // 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.Count; index++)
        {
            CredentialInfo credentialInfo = (CredentialInfo)arrayListObj[index];
            if(uriObj.Equals(credentialInfo.uriObj)&& authenticationType.Equals(credentialInfo.authenticationType))
                arrayListObj.RemoveAt(index);
        }
    }
    public NetworkCredential GetCredential (Uri uriObj, String authenticationType)
    {
        for(int index=0;index < arrayListObj.Count; index++)
        {
            CredentialInfo credentialInfoObj = (CredentialInfo)arrayListObj[index];
            if(uriObj.Equals(credentialInfoObj.uriObj) && authenticationType.Equals(credentialInfoObj.authenticationType))
                return credentialInfoObj.networkCredentialObj;
        }
        return null;
    }
};

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

Platforms

Windows 98, Windows Server 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 Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Reference

ICredentials Interface
ICredentials Members
System.Net Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD