IHttpResponse::SetErrorDescription-Methode

Artikel
07/19/2023

Gibt die benutzerdefinierte Fehlerbeschreibung an.

Syntax

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

Parameter

pszDescription
[IN] Ein Zeiger auf eine Zeichenfolge, die die benutzerdefinierte Fehlerbeschreibung enthält.

cchDescription
[IN] Ein DWORD , der die Länge der Zeichenfolge in pszDescriptionZeichen enthält.

fHtmlEncode
[IN] true , wenn die Zeichenfolge in pszDescription für HTML codiert werden soll, falseandernfalls .

Rückgabewert

HRESULT. Mögliches Werte (aber nicht die Einzigen) sind die in der folgenden Tabelle.

Wert	BESCHREIBUNG
S_OK	Gibt an, dass der Vorgang erfolgreich war.
ERROR_INVALID_PARAMETER	Gibt an, dass in einem der Parameter ein ungültiger Wert übergeben wurde.

Bemerkungen

Entwickler verwenden die SetErrorDescription -Methode, um die benutzerdefinierte Fehlerbeschreibung anzugeben. IIS zeigt die benutzerdefinierte Fehlerbeschreibung als Teil der detaillierten Informationen an, die an einen Webclient gesendet werden, wenn IIS eine Fehlermeldung zurückgibt.

Beispiel

Im folgenden Codebeispiel wird veranschaulicht, wie ein HTTP-Modul erstellt wird, das die folgenden Aufgaben ausführt:

Ruft mithilfe der IHttpContext::GetResponse-Methode einen Zeiger auf eine IHttpResponse-Schnittstelle ab.
Ruft den aktuellen HTTP-status Code mithilfe der IHttpResponse::GetStatus-Methode ab.
Wenn der aktuelle HTTP-status Code ein 404.0-Fehler ist, ruft die aktuelle benutzerdefinierte Fehlerbeschreibung mithilfe der IHttpResponse::GetErrorDescription-Methode ab.
Wenn derzeit keine benutzerdefinierte Fehlerbeschreibung definiert ist, wird die benutzerdefinierte Fehlerbeschreibung mithilfe der SetErrorDescription -Methode festgelegt.

#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
    );
}

Ihr Modul muss die RegisterModule-Funktion exportieren. Sie können diese Funktion exportieren, indem Sie eine Moduldefinitionsdatei (.def) für Ihr Projekt erstellen, oder Sie können das Modul mithilfe des Schalters /EXPORT:RegisterModule kompilieren. Weitere Informationen finden Sie unter Exemplarische Vorgehensweise: Erstellen eines Request-Level HTTP-Moduls mithilfe von nativem Code.

Sie können den Code optional kompilieren, indem Sie die __stdcall (/Gz) Aufrufkonvention verwenden, anstatt die Aufrufkonvention für jede Funktion explizit zu deklarieren.

Anforderungen

type	BESCHREIBUNG
Client	– IIS 7.0 unter Windows Vista – IIS 7.5 unter Windows 7 – IIS 8.0 unter Windows 8 – IIS 10.0 unter Windows 10
Server	– IIS 7.0 unter Windows Server 2008 – IIS 7.5 unter Windows Server 2008 R2 – IIS 8.0 unter Windows Server 2012 – IIS 8.5 unter Windows Server 2012 R2 – IIS 10.0 unter Windows Server 2016
Produkt	– 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

Weitere Informationen

IHttpResponse-Schnittstelle
IHttpResponse::GetErrorDescription-Methode

Freigeben über