Metodo IHttpResponse::SetHeader
Imposta o aggiunge il valore di un'intestazione di risposta HTTP specificata.
Sintassi
virtual HRESULT SetHeader(
IN PCSTR pszHeaderName,
IN PCSTR pszHeaderValue,
IN USHORT cchHeaderValue,
IN BOOL fReplace
) = 0;
virtual HRESULT SetHeader(
IN HTTP_HEADER_ID ulHeaderIndex,
IN PCSTR pszHeaderValue,
IN USHORT cchHeaderValue,
IN BOOL fReplace
) = 0;
Parametri
pszHeaderName
[IN] Puntatore a una stringa contenente il nome dell'intestazione HTTP da impostare.
ulHeaderIndex
[IN] ID di un'intestazione HTTP da impostare.
pszHeaderValue
[IN] Puntatore a una stringa contenente il valore dell'intestazione da impostare.
cchHeaderValue
[IN] Lunghezza, in caratteri, del valore dell'intestazione, non incluso il carattere \0.
fReplace
[IN] Specifica se l'intestazione esistente deve essere sovrascritta.
Valore restituito
Oggetto HRESULT. I valori possibili includono, ma non sono limitati a, quelli indicati nella tabella seguente.
| Valore | Descrizione |
|---|---|
| S_OK | Indica che l'operazione è riuscita. |
| ERROR_INVALID_DATA | Indica che i dati non sono validi, ad esempio i dati nell'intestazione sono troppo lunghi. |
| ERROR_INVALID_PARAMETER | Indica che il parametro specificato non è valido, ad esempio il parametro è impostato su NULL. |
| ERROR_NOT_ENOUGH_MEMORY | Indica che la memoria non è sufficiente per eseguire l'operazione. |
Commenti
Il SetHeader metodo imposta il valore di un'intestazione HTTP per la risposta corrente. Esistono due versioni di overload del SetHeader metodo . Il primo consente di specificare l'intestazione usando una stringa contenuta nel pszHeaderName parametro . L'altro overload usa un intero long senza segno contenuto nel ulHeaderIndex parametro .
Nota
Non usare l'overload che usa il ulHeaderIndex parametro per impostare il valore dell'intestazione, perché il valore verrà aggiunto al valore dell'intestazione Server esistente. Usare invece il pszHeaderName parametro .
Il nome dell'intestazione specificato dal pszHeaderName parametro può essere un'intestazione personalizzata o un'intestazione definita in Request for Comments (RFC) 1945, "Hypertext Transfer Protocol -- HTTP/1.0" o RFC 2616, "Hypertext Transfer Protocol -- HTTP/1.1".
Nota
Il pszHeaderName parametro non può essere NULL.
Il ulHeaderIndex parametro specifica l'ID di un'intestazione HTTP elencata nell'enumerazione HTTP_HEADER_ID .
Nota
L'enumerazione HTTP_HEADER_ID è definita nel file di intestazione Http.h.
Se il fReplace parametro è true, il valore di intestazione specificato sostituirà il valore dell'intestazione esistente se l'intestazione esiste. Se fReplace è false, il valore di intestazione specificato deve essere aggiunto all'intestazione esistente e separato dall'intestazione stessa da una virgola.
Nota
Altri moduli o gestori possono chiamare il metodo per sostituire il SetHeader valore o aggiungere valori al valore specificato.
Esempio
Nell'esempio di codice seguente viene illustrato come usare entrambi gli overload del SetHeader metodo per sostituire le intestazioni e Server HTTP Content-Type con valori personalizzati e impostare l'intestazione HTTP Refresh su un numero specifico di secondi.
#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 );
// Create an HRESULT to receive return values from methods.
HRESULT hr;
// Set the "Refresh" header name.
char szRefreshName[] = "Refresh";
// Set the "Refresh" header value.
char szRefreshValue[] = "30";
// Set the "Content-Type" header value.
char szContentType[] = "text/plain";
// Set the "Server" header value.
char szServerValue[] = "MyServer/7.0";
// Retrieve a pointer to the response.
IHttpResponse * pHttpResponse = pHttpContext->GetResponse();
// Test for an error.
if (pHttpResponse != NULL)
{
// Set the "Refresh" header.
hr = pHttpResponse->SetHeader(
szRefreshName,szRefreshValue,
(USHORT)strlen(szRefreshValue),FALSE);
// Test for an error.
if (FAILED(hr))
{
// Set the error status.
pProvider->SetErrorStatus( hr );
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
// Set the "Content-Type" header.
hr = pHttpResponse->SetHeader(
HttpHeaderContentType,szContentType,
(USHORT)strlen(szContentType),TRUE);
// Test for an error.
if (FAILED(hr))
{
// Set the error status.
pProvider->SetErrorStatus( hr );
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
// Set the "Server" header.
hr = pHttpResponse->SetHeader(
"Server",szServerValue,
(USHORT)strlen(szServerValue),TRUE);
// 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;
}
};
// 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
);
}
Il modulo deve esportare la funzione RegisterModule . È possibile esportare questa funzione creando un file di definizione del modulo (con estensione def) per il progetto oppure è possibile compilare il modulo usando l'opzione /EXPORT:RegisterModule . Per altre informazioni, vedere Procedura dettagliata: Creazione di un modulo HTTP Request-Level tramite codice nativo.
Facoltativamente, è possibile compilare il codice usando la __stdcall (/Gz) convenzione di chiamata anziché dichiarare in modo esplicito la convenzione di chiamata per ogni funzione.
Requisiti
| Tipo | Descrizione |
|---|---|
| Client | - IIS 7.0 in Windows Vista - IIS 7.5 in Windows 7 - IIS 8.0 in Windows 8 - IIS 10.0 in Windows 10 |
| Server | - IIS 7.0 in Windows Server 2008 - IIS 7.5 in Windows Server 2008 R2 - IIS 8.0 in Windows Server 2012 - IIS 8.5 in Windows Server 2012 R2 - IIS 10.0 in Windows Server 2016 |
| Prodotto | - 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 |
| Intestazione | Httpserv.h |
Vedere anche
Interfaccia IHttpResponse
Metodo IHttpResponse::D eleteHeader
Metodo IHttpResponse::GetHeader
Commenti e suggerimenti
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedere https://aka.ms/ContentUserFeedback.
Invia e visualizza il feedback per