Skip to content

ihttpresponse-geterrordescription-method.md

Latest commit

 

History

History
56 lines (40 loc) · 4 KB

ihttpresponse-geterrordescription-method.md

File metadata and controls

56 lines (40 loc) · 4 KB
Raw
title IHttpResponse::GetErrorDescription Method
description Describes the IHttpResponse::GetErrorDescription method and details its syntax, parameters, return value, remarks, code example, and requirements.
ms.date 10/07/2016
ms.assetid 11e42b08-ce5d-436b-aa14-05069dc4b5a8

IHttpResponse::GetErrorDescription Method

Retrieves the custom error description.

Syntax

virtual PCWSTR GetErrorDescription(  
   OUT DWORD* pcchDescription = NULL  
) = 0;

Parameters

pcchDescription
[OUT] A pointer to a DWORD value that contains the length, in characters, of the returned string.

Return Value

A pointer to a string that contains the custom error description.

Remarks

Developers use the GetErrorDescription method to retrieve the custom error description. IIS displays the custom error description as part of the detailed information that is sent to a Web client when IIS returns an error message.

Example

The following code example demonstrates how to create an HTTP module that performs the following tasks:

  1. Retrieves a pointer to an IHttpResponse interface by using the IHttpContext::GetResponse method.

  2. Retrieves the current HTTP status code by using the IHttpResponse::GetStatus method.

  3. If the current HTTP status code is a 404.0 error, retrieves the current custom error description by using the GetErrorDescription method.

  4. If no custom error description is currently defined, sets the custom error description by using the IHttpResponse::SetErrorDescription method.

[!code-cppIHttpResponseSetErrorDescription#1]

Your module must export the RegisterModule function. You can export this function by creating a module definition (.def) file for your project, or you can compile the module by using the /EXPORT:RegisterModule switch. For more information, see Walkthrough: Creating a Request-Level HTTP Module By Using Native Code.

You can optionally compile the code by using the __stdcall (/Gz) calling convention instead of explicitly declaring the calling convention for each function.

Requirements

Type Description
Client - IIS 7.0 on [!INCLUDEwinvista]
- IIS 7.5 on Windows 7
- IIS 8.0 on Windows 8
- IIS 10.0 on Windows 10
Server - IIS 7.0 on [!INCLUDEwinsrv2008]
- IIS 7.5 on Windows Server 2008 R2
- IIS 8.0 on Windows Server 2012
- IIS 8.5 on Windows Server 2012 R2
- IIS 10.0 on Windows Server 2016
Product - IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0
- [!INCLUDEiisexp75], [!INCLUDEiisexp80], [!INCLUDEiisexp100]
Header Httpserv.h

See Also

IHttpResponse Interface
IHttpResponse::SetErrorDescription Method