IHttpResponse::GetStatus Method
Retrieves the HTTP status for the response.
Syntax
virtual VOID GetStatus(
OUT USHORT * pStatusCode,
OUT USHORT * pSubStatus = NULL,
OUT PCSTR * ppszReason = NULL,
OUT USHORT * pcchReason = NULL,
OUT HRESULT * phrErrorToReport = NULL,
OUT PCWSTR * ppszModule = NULL,
OUT DWORD * pdwNotification = NULL,
OUT INativeSectionException ** ppException = NULL
) = 0;
Parameters
pStatusCode
[OUT] A pointer to an unsigned short integer that receives the HTTP status code for the response.
pSubStatus
[OUT] A pointer to an unsigned short integer that receives the HTTP substatus code for the response.
ppszReason
[OUT] A pointer to a string that receives the HTTP status text for the response.
pcchReason
[OUT] A pointer to an unsigned short integer that receives the length, in characters, of the response status string.
phrErrorToReport
[OUT] A pointer to an HRESULT that receives the Win32 error associated with the response status.
ppszModule
[OUT] A pointer to a string that receives the name of the module that set the status.
pdwNotification
[OUT] A pointer to a DWORD that receives the notification during which the error status was set.
ppException
[OUT] A pointer to an INativeSectionException interface that is associated with this status.
Return Value
VOID.
Remarks
The GetStatus method returns the complete HTTP response status, which consists of the status code, the substatus code, the status text, and—if an error exists—the Win32 error associated with the response status.
Note
The response status string is in a server-owned buffer.
Example
The following code example demonstrates how to use the GetStatus method to create an HTTP module that retrieves the HTTP response status. The example module returns the contents of the HTTP response status to the client, and it calls the IHttpResponse::SetStatus method to set the response status to "200 OK" so the client will always receive the result.
#define _WINSOCKAPI_
#include <windows.h>
#include <sal.h>
#include <httpserv.h>
// Create the module class.
class MyHttpModule : public CHttpModule
{
public:
REQUEST_NOTIFICATION_STATUS
OnBeginRequest(
IN IHttpContext * pHttpContext,
IN IHttpEventProvider * pProvider
)
{
UNREFERENCED_PARAMETER( pProvider );
// Create buffers for the HTTP status fields.
USHORT uStatusCode;
USHORT uSubStatus;
PCSTR pszReason;
USHORT chReason;
PCWSTR pszModule;
DWORD pdwNotification;
// Create an HRESULT to receive return values from methods.
HRESULT hr;
// Retrieve a pointer to the response.
IHttpResponse * pHttpResponse = pHttpContext->GetResponse();
// Test for an error.
if (pHttpResponse != NULL)
{
// Retrieve the current HTTP status.
pHttpResponse->GetStatus(
&uStatusCode,&uSubStatus,&pszReason,&chReason,
&hr,&pszModule,&pdwNotification,NULL);
// Test for an error.
if (NULL != pszReason)
{
// Clear the existing response.
pHttpContext->GetResponse()->Clear();
// Set the MIME type to plain text.
pHttpContext->GetResponse()->SetHeader(
HttpHeaderContentType,"text/plain",
(USHORT)strlen("text/plain"),TRUE);
// Create a buffer for the return message.
char szBuffer[256];
// Format the HTTP status.
sprintf_s(szBuffer,255,"%u.%u %s",
uStatusCode,uSubStatus,pszReason);
// Return the status to the client.
WriteResponseMessage(pHttpContext,
"HTTP Status: ",szBuffer);
// Set the HTTP status code.
uStatusCode = 200;
// Set the HTTP substatus code.
uSubStatus = 0;
// Set the HTTP status message.
strcpy_s(szBuffer,255,"OK");
// Set the HTTP status.
hr = pHttpResponse->SetStatus(uStatusCode,
szBuffer,uSubStatus,S_OK);
// Test for an error.
if (FAILED(hr))
{
// Set the error status.
pProvider->SetErrorStatus( hr );
}
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
}
// Return processing to the pipeline.
return RQ_NOTIFICATION_CONTINUE;
}
private:
// Create a utility method that inserts a name/value pair into the response.
HRESULT WriteResponseMessage(
IHttpContext * pHttpContext,
PCSTR pszName,
PCSTR pszValue
)
{
// Create an HRESULT to receive return values from methods.
HRESULT hr;
// Create a data chunk.
HTTP_DATA_CHUNK dataChunk;
// Set the chunk to a chunk in memory.
dataChunk.DataChunkType = HttpDataChunkFromMemory;
// Buffer for bytes written of data chunk.
DWORD cbSent;
// Set the chunk to the first buffer.
dataChunk.FromMemory.pBuffer =
(PVOID) pszName;
// Set the chunk size to the first buffer size.
dataChunk.FromMemory.BufferLength =
(USHORT) strlen(pszName);
// Insert the data chunk into the response.
hr = pHttpContext->GetResponse()->WriteEntityChunks(
&dataChunk,1,FALSE,TRUE,&cbSent);
// Test for an error.
if (FAILED(hr))
{
// Return the error status.
return hr;
}
// Set the chunk to the second buffer.
dataChunk.FromMemory.pBuffer =
(PVOID) pszValue;
// Set the chunk size to the second buffer size.
dataChunk.FromMemory.BufferLength =
(USHORT) strlen(pszValue);
// Insert the data chunk into the response.
hr = pHttpContext->GetResponse()->WriteEntityChunks(
&dataChunk,1,FALSE,TRUE,&cbSent);
// Test for an error.
if (FAILED(hr))
{
// Return the error status.
return hr;
}
// Return a success status.
return S_OK;
}
};
// 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_BEGIN_REQUEST,
0
);
}
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 Windows Vista - IIS 7.5 on Windows 7 - IIS 8.0 on Windows 8 - IIS 10.0 on Windows 10 |
| Server | - IIS 7.0 on Windows Server 2008 - 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 - IIS Express 7.5, IIS Express 8.0, IIS Express 10.0 |
| Header | Httpserv.h |
See Also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for