IHttpResponse::GetHeader-Methode
Gibt den Wert eines angegebenen HTTP-Headers zurück.
Syntax
virtual PCSTR GetHeader(
IN PCSTR pszHeaderName,
OUT USHORT* pcchHeaderValue = NULL
) const = 0;
virtual PCSTR GetHeader(
IN HTTP_HEADER_ID ulHeaderIndex,
OUT USHORT* pcchHeaderValue = NULL
) const = 0;
Parameter
pszHeaderName
[IN] Ein Zeiger auf eine Zeichenfolge, die den Namen des zurückzugebenden Headers enthält.
ulHeaderIndex
[IN] Die ID eines http-Headers, der zurückgegeben werden soll.
pcchHeaderValue
[OUT] Ein Zeiger auf einen USHORT , der die Länge des Headerwerts empfängt.
Rückgabewert
Ein Zeiger auf eine Zeichenfolge, die den angegebenen Header enthält.
Hinweise
Die GetHeader -Methode gibt den Wert eines HTTP-Headers zurück. Es gibt zwei überladene Versionen der GetHeader -Methode. Eine gibt den Header mithilfe einer Zeichenfolge an, die pszHeaderName im Parameter enthalten ist. Die andere Überladung verwendet eine ganze Zahl ohne Vorzeichen, die ulHeaderIndex im -Parameter enthalten ist.
Der durch den Parameter angegebene Headername kann ein benutzerdefinierter Header oder ein Header sein, der pszHeaderName in Request for Comments (RFC) 1945, "Hypertext Transfer Protocol -- HTTP/1.0", oder RFC 2616, "Hypertext Transfer Protocol -- HTTP/1.1" definiert ist.
Hinweis
Der pszHeaderName Parameter kann nicht auf NULL festgelegt werden.
Der ulHeaderIndex Parameter gibt die ID eines HTTP-Headers an, der in der HTTP_HEADER_ID Enumeration aufgeführt ist.
Hinweis
Die HTTP_HEADER_ID Enumeration wird in der Http.h-Headerdatei definiert.
Nachdem Sie die GetHeader -Methode aufgerufen haben, enthält der pcchHeaderValue Parameter die Länge des Headerwerts in Zeichen, ohne das endende Zeichen, oder 0, wenn der Header nicht gefunden wurde.
Beispiel
Im folgenden Codebeispiel wird veranschaulicht, wie Sie mithilfe der GetHeader -Methode ein HTTP-Modul erstellen, das die Werte der Server Header und Location abruft. Das Modul sendet diese Informationen dann an einen Webclient.
#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 an HRESULT to receive return values from methods.
HRESULT hr;
// Buffers to store the header values.
PCSTR pszServerHeader;
PCSTR pszLocationHeader;
// Lengths of the returned header values.
USHORT cchServerHeader;
USHORT cchLocationHeader;
// Retrieve a pointer to the response.
IHttpResponse * pHttpResponse = pHttpContext->GetResponse();
// Test for an error.
if (pHttpResponse != NULL)
{
// Clear the existing response.
pHttpResponse->Clear();
// Set the MIME type to plain text.
pHttpResponse->SetHeader(
HttpHeaderContentType,"text/plain",
(USHORT)strlen("text/plain"),TRUE);
// Retrieve the length of the "Server" header.
pszServerHeader = pHttpResponse->GetHeader("Server",&cchServerHeader);
if (cchServerHeader > 0)
{
// Allocate space to store the header.
pszServerHeader = (PCSTR) pHttpContext->AllocateRequestMemory( cchServerHeader + 1 );
// Test for an error.
if (pszServerHeader==NULL)
{
// Set the error status.
hr = HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
pProvider->SetErrorStatus( hr );
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
// Retrieve the "Server" header.
pszServerHeader = pHttpResponse->GetHeader(
"Server",&cchServerHeader);
// Return the "Server" header to the client.
WriteResponseMessage(pHttpContext,
"Server: ",pszServerHeader);
}
// Retrieve the length of the "Location" header.
pszLocationHeader = pHttpResponse->GetHeader(
HttpHeaderLocation,&cchLocationHeader);
if (cchLocationHeader > 0)
{
// Allocate space to store the header.
pszLocationHeader =
(PCSTR) pHttpContext->AllocateRequestMemory( cchLocationHeader + 1 );
// Test for an error.
if (pszServerHeader==NULL)
{
// Set the error status.
hr = HRESULT_FROM_WIN32(ERROR_NOT_ENOUGH_MEMORY);
pProvider->SetErrorStatus( hr );
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
// Retrieve the "Location" header.
pszLocationHeader = pHttpResponse->GetHeader(
HttpHeaderLocation,&cchLocationHeader);
// Return the "Location" header to the client.
WriteResponseMessage(pHttpContext,
"Location: ",pszLocationHeader);
}
// 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
| Typ | BESCHREIBUNG |
|---|---|
| Client | – IIS 7.0 unter Windows Vista – IIS 7.5 unter Windows 7 – IIS 8.0 auf 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 auf Windows Server 2012 – IIS 8.5 auf 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::SetHeader-Methode
IHttpResponse::D eleteHeader-Methode