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
Assemblies:   System (in System.dll)
  System.Net.Primitives (in System.Net.Primitives.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, a null reference (Nothing in Visual Basic).

Implements

ICredentials.GetCredential(Uri, String)

ExceptionCondition
ArgumentNullException

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

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.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Store apps

Supported in: Windows 8

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8

Windows Phone 8.1, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft