Skip to content

ihttpresponse-seterrordescription-method.md

Latest commit

 

History

History
69 lines (50 loc) · 4.46 KB

ihttpresponse-seterrordescription-method.md

File metadata and controls

69 lines (50 loc) · 4.46 KB
title IHttpResponse::SetErrorDescription Method
ms.date 10/07/2016
description The IHttpResponse SetErrorDescription Method specifies the custom error description with Parameters and a Return Value.
ms.assetid 65e5e9a2-0efc-4d11-af6b-c152d58d8b2b

IHttpResponse::SetErrorDescription Method

Specifies the custom error description.

Syntax

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

Parameters

pszDescription
[IN] A pointer to a string that contains the custom error description.

cchDescription
[IN] A DWORD that contains the length, in characters, of the string in pszDescription.

fHtmlEncode
[IN] true if the string in pszDescription should be encoded for HTML; otherwise, false.

Return Value

An HRESULT. Possible values include, but are not limited to, those in the following table.

Value Description
S_OK Indicates that the operation was successful.
ERROR_INVALID_PARAMETER Indicates that an invalid value was passed in one of the parameters.

Remarks

Developers use the SetErrorDescription method to specify 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 IHttpResponse::GetErrorDescription method.

  4. If no custom error description is currently defined, sets the custom error description by using the 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::GetErrorDescription Method