IHttpResponse::SetStatus-Methode
Legt den HTTP-status für die Antwort fest.
Syntax
virtual HRESULT SetStatus(
IN USHORT statusCode,
IN PCSTR pszReason,
IN USHORT uSubStatus = 0,
IN HRESULT hrErrorToReport = S_OK,
IN INativeSectionException* pException = NULL
) = 0;
Parameter
statusCode
[IN] Der festzulegende HTTP-status Code.
pszReason
[IN] Ein Zeiger auf eine Zeichenfolge, die den festzulegenden HTTP-status Text enthält.
uSubStatus
[IN] Der optionale HTTP-Unterstatuscode, der festgelegt werden soll.
hrErrorToReport
[IN] Der optionale Win32-Fehler, der der Antwort status Code zugeordnet ist.
pException
[IN] Ein Zeiger auf eine optionale INativeSectionException-Schnittstelle .
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_DATA | Gibt an, dass die Daten ungültig sind (z. B. sind die Daten im status Text zu lang). |
| ERROR_NOT_ENOUGH_MEMORY | Gibt an, dass nicht genügend Arbeitsspeicher zum Ausführen des Vorgangs vorhanden ist. |
Bemerkungen
Die SetStatus -Methode konfiguriert die HTTP-Antwort status, die aus dem status-Code, dem Unterstatuscode, dem status Text, einem win32-Fehler (sofern vorhanden) besteht, der der Antwort zugeordnet ist, und einer optionalen INativeSectionException-Schnittstelle.
Beispiel
Im folgenden Codebeispiel wird veranschaulicht, wie Sie mithilfe der GetStatus -Methode ein HTTP-Modul erstellen, das die HTTP-Antwort status abruft. Das Beispielmodul gibt den Inhalt der HTTP-Antwort status an den Client zurück und ruft dann die SetStatus -Methode auf, um die Antwort status auf "200 OK" festzulegen, damit der Client das Ergebnis immer empfängt.
#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
);
}
Ihr Modul muss die Funktion RegisterModule 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 /EXPORT:RegisterModule Switches 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) aufrufende Konvention verwenden, anstatt die aufrufende Konvention 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 auf 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 auf 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::GetStatus-Methode