ICredentialPolicy.ShouldSendCredential メソッド

.NET Framework クラス ライブラリ リファレンス

ICredentialPolicy.ShouldSendCredential メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

WebRequest クラスのインスタンスを使用して行われるリソース要求と共にクライアントの資格情報を送信するかどうかを示す Boolean を返します。

名前空間: System.Net
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Function ShouldSendCredential ( _
    challengeUri As Uri, _
    request As WebRequest, _
    credential As NetworkCredential, _
    authenticationModule As IAuthenticationModule _
) As Boolean

Visual Basic (使用法)

Dim instance As ICredentialPolicy
Dim challengeUri As Uri
Dim request As WebRequest
Dim credential As NetworkCredential
Dim authenticationModule As IAuthenticationModule
Dim returnValue As Boolean

returnValue = instance.ShouldSendCredential(challengeUri, request, credential, authenticationModule)

C#

bool ShouldSendCredential (
    Uri challengeUri,
    WebRequest request,
    NetworkCredential credential,
    IAuthenticationModule authenticationModule
)

C++

bool ShouldSendCredential (
    Uri^ challengeUri, 
    WebRequest^ request, 
    NetworkCredential^ credential, 
    IAuthenticationModule^ authenticationModule
)

J#

boolean ShouldSendCredential (
    Uri challengeUri, 
    WebRequest request, 
    NetworkCredential credential, 
    IAuthenticationModule authenticationModule
)

JScript

function ShouldSendCredential (
    challengeUri : Uri, 
    request : WebRequest, 
    credential : NetworkCredential, 
    authenticationModule : IAuthenticationModule
) : boolean

パラメータ

challengeUri

要求を受信する Uri。詳細については、「解説」を参照してください。

request

要求されるリソースを表す WebRequest。

credential

このメソッドが true を返した場合に要求と共に送信される NetworkCredential。

authenticationModule

認証が必要な場合に認証を実行する IAuthenticationModule。

戻り値
要求と共に資格情報が送信される場合は true。それ以外の場合は false。

解説

AuthenticationManager.CredentialPolicy プロパティを設定して ICredentialPolicy ポリシーが指定されると、WebRequest の認証を処理する IAuthenticationModule は、認証の実行前に ShouldSendCredential メソッドを呼び出します。このメソッドから false が返された場合、認証は実行されません。

元の要求がリダイレクトされている場合、またはプロキシ認証が必要な場合は、challengeUri で識別されるリソースが WebRequest.RequestUri で指定された要求リソースとは異なることがあります。リダイレクトされている場合、challengeUri には、実際の送信先 Uri が格納されます。プロキシ認証が必要な場合、challengeUri には、クライアント認証を必要とするプロキシ サーバーのアドレスが格納されます。

プラットフォーム

Windows 98, Windows 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ICredentialPolicy インターフェイス
ICredentialPolicy メンバ
System.Net 名前空間