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 의 pszDescription 문자열을 HTML용으로 인코딩해야 하면 이고, false그렇지 않으면 입니다.
반환 값
HRESULT입니다. 가능한 값에는 다음 표에 있는 값이 포함되지만, 이에 국한되는 것은 아닙니다.
| 값 | 설명 |
|---|---|
| S_OK | 작업이 성공했음을 나타냅니다. |
| ERROR_INVALID_PARAMETER | 매개 변수 중 하나에서 잘못된 값이 전달되었음을 나타냅니다. |
설명
개발자는 메서드를 SetErrorDescription 사용하여 사용자 지정 오류 설명을 지정합니다. IIS는 IIS가 오류 메시지를 반환할 때 웹 클라이언트로 전송되는 자세한 정보의 일부로 사용자 지정 오류 설명을 표시합니다.
예제
다음 코드 예제에서는 다음 작업을 수행하는 HTTP 모듈을 만드는 방법을 보여 줍니다.
IHttpContext::GetResponse 메서드를 사용하여 IHttpResponse 인터페이스에 대한 포인터를 검색합니다.
IHttpResponse::GetStatus 메서드를 사용하여 현재 HTTP 상태 코드를 검색합니다.
현재 HTTP 상태 코드가 404.0 오류인 경우 IHttpResponse::GetErrorDescription 메서드를 사용하여 현재 사용자 지정 오류 설명을 검색합니다.
사용자 지정 오류 설명이 현재 정의되어 있지 않으면 메서드를 사용하여
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) 코드를 컴파일할 수 있습니다.
요구 사항
| 형식 | Description |
|---|---|
| 클라이언트 | - 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 |
| 헤더 | Httpserv.h |