Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

CredentialCache.GetCredential Method (Uri, String)

Returns the NetworkCredential instance associated with the specified Uniform Resource Identifier (URI) and authentication type.

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

Public Function GetCredential ( _
	uriPrefix As Uri, _
	authType As String _
) As NetworkCredential
Dim instance As CredentialCache
Dim uriPrefix As Uri
Dim authType As String
Dim returnValue As NetworkCredential

returnValue = instance.GetCredential(uriPrefix, authType)
public final NetworkCredential GetCredential (
	Uri uriPrefix, 
	String authType
public final function GetCredential (
	uriPrefix : Uri, 
	authType : String
) : NetworkCredential
Not applicable.



A Uri that specifies the URI prefix of the resources that the credential grants access to.


The authentication scheme used by the resource named in uriPrefix.

Return Value

A NetworkCredential or, if there is no matching credential in the cache, a null reference (Nothing in Visual Basic).

Exception typeCondition


uriPrefix or authType is a null reference (Nothing in Visual Basic).

The GetCredential(Uri,String) method searches the CredentialCache and returns the NetworkCredential instance for the specified URI and authorization type. If the CredentialCache contains no matching NetworkCredential instance, a null reference (Nothing in Visual Basic) is returned.

GetCredential uses the longest matching URI prefix in the cache to determine which set of credentials to return for an authorization type. The following table shows examples.

URI Prefix



Requests for the specific Web page news.htm.


Requests for all content in the portal path, except the page news.htm.


Requests for all resources at www.contoso.com, except those in the portal path.

The following code example uses the GetCredential(Uri,String) method to return the NetworkCredential instance associated with the specified URI and authentication type.

Public Shared Sub GetPage(url As String, userName As String, password As String, domainName As String)
        Dim myCredentialCache As New CredentialCache()
        ' Dummy names used as credentials    
        myCredentialCache.Add(New Uri("http://microsoft.com/"), "Basic", New NetworkCredential("user1", "passwd1", "domain1"))
        myCredentialCache.Add(New Uri("http://msdn.com/"), "Basic", New NetworkCredential("user2", "passwd2", "domain2"))
        myCredentialCache.Add(New Uri(url), "Basic", New NetworkCredential(userName, password, domainName))
        ' Creates a webrequest with the specified url. 
        Dim myWebRequest As WebRequest = WebRequest.Create(url)
        ' Call 'GetCredential' to obtain the credentials specific to our Uri.
        Dim myCredential As NetworkCredential = myCredentialCache.GetCredential(New Uri(url), "Basic")
        myWebRequest.Credentials = myCredential 'Associating only our credentials            
        ' Sends the request and waits for response.
        Dim myWebResponse As WebResponse = myWebRequest.GetResponse()
        ' Process response here.
        Console.WriteLine(ControlChars.Cr + "Response Received.")

    Catch e As WebException
        If Not (e.Response Is Nothing) Then
            Console.WriteLine(ControlChars.Lf + ControlChars.Cr + "Failed to obtain a response. The following error occured : {0}", CType(e.Response, HttpWebResponse).StatusDescription)
            Console.WriteLine(ControlChars.Lf + ControlChars.Cr + "Failed to obtain a response. The following error occured : {0}", e.Status)
        End If
    Catch e As Exception
        Console.WriteLine(ControlChars.Cr + "The following exception was raised : {0}", e.Message)
    End Try
End Sub 'GetPage

Public Shared Sub Display(ByVal credential As NetworkCredential)
    Console.WriteLine("The credentials are: ")
    Console.WriteLine(ControlChars.Cr + "Username : {0} ,Password : {1} ,Domain : {2}", credential.UserName, credential.Password, credential.Domain)
End Sub 'Display

public static void GetPage(String url, String userName, String password, 
    String domainName)
    try {
        CredentialCache myCredentialCache = new CredentialCache();

        // Dummy names used as credentials.    
        myCredentialCache.Add(new Uri("http://microsoft.com/"), "Basic", 
            new NetworkCredential("user1", "passwd1", "domain1"));
        myCredentialCache.Add(new Uri("http://msdn.com/"), "Basic", 
            new NetworkCredential("user2", "passwd2", "domain2"));
        myCredentialCache.Add(new Uri(url), "Basic", 
            new NetworkCredential(userName, password, domainName));

        // Create a webrequest with the specified url.
        WebRequest myWebRequest = WebRequest.Create(url);

        // Call 'GetCredential' to obtain the credentials specific to our Uri.
        NetworkCredential myCredential = myCredentialCache.
            GetCredential(new Uri(url), "Basic");

        // Associating only our credentials.        

        // Sends the request and waits for response.
        WebResponse myWebResponse = myWebRequest.GetResponse();

        // Process response here.
        Console.WriteLine("\nResponse Received.");
    catch (WebException e) {
        if (e.get_Response() != null) {
            Console.WriteLine("\r\nFailed to obtain a response. "
                + "The following error occured : {0}", ((HttpWebResponse)
        else {
            Console.WriteLine("\r\nFailed to obtain a response. "
                + "The following error occured : {0}", e.get_Status());
    catch (System.Exception e) {
        Console.WriteLine("\nThe following exception was raised : {0}", 
} //GetPage

public static void Display(NetworkCredential credential)
    Console.WriteLine("\nThe credentials are:");
    Console.WriteLine("\nUsername : {0} ,Password : {1} ,Domain : {2}", 
        credential.get_UserName(), credential.get_Password(), 
} //Display

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, 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.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0

Community Additions

© 2015 Microsoft