IHttpResponse::SetErrorDescription メソッド

カスタム エラーの説明を指定します。

構文

virtual HRESULT SetErrorDescription(  
   IN PCWSTR pszDescription,  
   IN DWORD cchDescription,  
   IN BOOL fHtmlEncode = TRUE  
) = 0;  

パラメーター

pszDescription
[IN]カスタム エラーの説明を含む文字列へのポインター。

cchDescription
[IN] DWORD 内の文字列の長さを文字数で pszDescription表す 。

fHtmlEncode
[IN] true の文字列を HTML 用に pszDescription エンコードする場合は 。それ以外の場合 falseは 。

戻り値

HRESULT。 有効な値を次の表に示しますが、これ以外にもあります。

値	説明
S_OK	操作が成功したことを示します。
ERROR_INVALID_PARAMETER	いずれかのパラメーターで無効な値が渡されたことを示します。

解説

開発者は、 メソッドを SetErrorDescription 使用してカスタム エラーの説明を指定します。 IIS は、IIS がエラー メッセージを返したときに Web クライアントに送信される詳細情報の一部として、カスタム エラーの説明を表示します。

例

次のコード例では、次のタスクを実行する HTTP モジュールを作成する方法を示します。

1. IHttpContext::GetResponse メソッドを使用して、IHttpResponse インターフェイスへのポインターを取得します。

2. IHttpResponse::GetStatus メソッドを使用して、現在の HTTP 状態コードを取得します。

3. 現在の HTTP 状態コードが 404.0 エラーの場合は、 IHttpResponse::GetErrorDescription メソッドを使用して、現在のカスタム エラーの説明を取得します。

4. カスタム エラーの説明が現在定義されていない場合は、 メソッドを使用してカスタム エラーの説明を SetErrorDescription 設定します。

#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>

// Create the module class.
class MyHttpModule : public CHttpModule
{
public:

    REQUEST_NOTIFICATION_STATUS
    OnSendResponse(
        IN IHttpContext * pHttpContext,
        IN ISendResponseProvider * pProvider
    )
    {
        UNREFERENCED_PARAMETER( pProvider );

        // Retrieve a a pointer to the current response.
        IHttpResponse * pHttpResponse = pHttpContext->GetResponse();

        // Test for errors.
        if (NULL != pHttpResponse)
        {
            USHORT uStatusCode = 0;
            USHORT uSubStatus = 0;

            // Retrieve the current HTTP status code.
            pHttpResponse->GetStatus(&uStatusCode,&uSubStatus);

            // Process only 404.0 errors.
            if (uStatusCode==404 && uSubStatus==0)
            {
                DWORD cchDescription = 0;
                
                // Retrieve the current error description.
                PCWSTR pwszErrorDescription =
                    pHttpResponse->GetErrorDescription(&cchDescription);

                // Process only if no error description is currently defined.
                if (cchDescription==0)
                {
                    // Define the new error description.
                    PCWSTR wszNewDescription =
                        L"The file that you requested cannot be found.";
                    // Configure the new error description.
                    pHttpResponse->SetErrorDescription(
                        wszNewDescription,wcslen(wszNewDescription),TRUE);               
                }
            }
        }
        // Return processing to the pipeline.
        return RQ_NOTIFICATION_CONTINUE;
    }
};

// Create the module's class factory.
class MyHttpModuleFactory : public IHttpModuleFactory
{
public:
    HRESULT
    GetHttpModule(
        OUT CHttpModule ** ppModule, 
        IN IModuleAllocator * pAllocator
    )
    {
        UNREFERENCED_PARAMETER( pAllocator );

        // Create a new instance.
        MyHttpModule * pModule = new MyHttpModule;

        // Test for an error.
        if (!pModule)
        {
            // Return an error if the factory cannot create the instance.
            return HRESULT_FROM_WIN32( ERROR_NOT_ENOUGH_MEMORY );
        }
        else
        {
            // Return a pointer to the module.
            *ppModule = pModule;
            pModule = NULL;
            // Return a success status.
            return S_OK;
        }            
    }

    void Terminate()
    {
        // Remove the class from memory.
        delete this;
    }
};

// Create the module's exported registration function.
HRESULT
__stdcall
RegisterModule(
    DWORD dwServerVersion,
    IHttpModuleRegistrationInfo * pModuleInfo,
    IHttpServer * pGlobalInfo
)
{
    UNREFERENCED_PARAMETER( dwServerVersion );
    UNREFERENCED_PARAMETER( pGlobalInfo );

    // Set the request notifications and exit.
    return pModuleInfo->SetRequestNotifications(
        new MyHttpModuleFactory,
        RQ_SEND_RESPONSE,
        0
    );
}

モジュールで RegisterModule 関数をエクスポートする必要があります。 この関数をエクスポートするには、プロジェクトのモジュール定義 (.def) ファイルを作成するか、 スイッチを使用してモジュールを /EXPORT:RegisterModule コンパイルします。 詳細については、「 チュートリアル: ネイティブ コードを使用したRequest-Level HTTP モジュールの作成」を参照してください。

必要に応じて、各関数の呼び出し規約を __stdcall (/Gz) 明示的に宣言するのではなく、呼び出し規約を使用してコードをコンパイルできます。

要件

Type	説明
Client	- Windows Vista 上の IIS 7.0 - Windows 7 上の IIS 7.5 - Windows 8 上の IIS 8.0 - Windows 10の IIS 10.0
サーバー	- Windows Server 2008 の IIS 7.0 - Windows Server 2008 R2 の IIS 7.5 - Windows Server 2012 の IIS 8.0 - Windows Server 2012 R2 の IIS 8.5 - Windows Server 2016の IIS 10.0
製品	- IIS 7.0、IIS 7.5、IIS 8.0、IIS 8.5、IIS 10.0 - IIS Express 7.5、IIS Express 8.0、IIS Express 10.0
Header	Httpserv.h

参照

IHttpResponse インターフェイス
IHttpResponse::GetErrorDescription メソッド