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)

abstract GetCredential : 
        uriPrefix:Uri *
        authType:string -> NetworkCredential
override GetCredential : 
        uriPrefix:Uri *
        authType:string -> NetworkCredential

Parameters

uriPrefix
Type: System.Uri

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

authType
Type: System.String

The authentication scheme used by the resource named in uriPrefix.

Return Value

Type: System.Net.NetworkCredential

A NetworkCredential or, if there is no matching credential in the cache, null.

Exception Condition
ArgumentNullException

uriPrefix or authType is null.

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, null 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

Matches

http://www.contoso.com/portal/news.htm

Requests for the specific Web page news.htm.

http://www.contoso.com/portal/

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

http://www.contoso.com/

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.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.1
Windows Phone
Available since 8.1
Return to top
Show: