IHttpResponse::Flush, méthode
Envoie le contenu existant dans la mémoire tampon de réponse au client.
Syntaxe
virtual HRESULT Flush(
IN BOOL fAsync,
IN BOOL fMoreData,
OUT DWORD* pcbSent,
OUT BOOL* pfCompletionExpected = NULL
) = 0;
Paramètres
fAsync
[IN] true
pour terminer l’opération de manière asynchrone ; sinon, false
.
fMoreData
[IN] true
pour envoyer plus de données dans cette réponse ; sinon, false
.
pcbSent
[OUT] Pointeur vers un DWORD
qui reçoit le nombre d’octets envoyés au client.
pfCompletionExpected
[OUT] Pointeur vers une valeur booléenne qui reçoit si une exécution asynchrone est en attente pour cet appel.
Valeur renvoyée
Élément HRESULT
. Les valeurs possibles sont notamment celles figurant dans le tableau suivant.
Valeur | Description |
---|---|
S_OK | Indique que l’opération a réussi. |
ERROR_INVALID_DATA | Indique que les données ne sont pas valides. |
ERROR_NOT_ENOUGH_MEMORY | Indique que la mémoire est insuffisante pour effectuer l’opération. |
Remarques
La Flush
méthode envoie la réponse actuellement disponible au client. Au minimum, la réponse inclut les en-têtes status, mais elle inclut également toute mémoire tampon de réponse qui existe lorsque vous appelez la méthode.
Définissez le fMoreData
paramètre true
sur si d’autres données seront retournées après l’appel de la Flush
méthode, ou définissez fMoreData
sur false
s’il n’y a pas de données restantes.
La Flush
méthode prend en charge les opérations synchrones et asynchrones. Spécifiez le mode d’opération en définissant le fAsync
paramètre sur true
si l’opération est asynchrone ou sur fAsync
false
si l’opération est synchrone.
Notes
Si vous appelez cette méthode de manière asynchrone, vous devez revenir immédiatement après l’appel.
Exemple
L’exemple de code suivant montre comment utiliser la Flush
méthode pour envoyer la réponse actuelle au client. Étant donné que la Flush
méthode a envoyé les en-têtes de réponse au client, l’appel suivant à la méthode Clear n’aura aucun effet.
#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;
// Buffer to store the byte count.
DWORD cbSent = 0;
// Buffer to store if asyncronous completion is pending.
BOOL fCompletionExpected = false;
// Retrieve a pointer to the response.
IHttpResponse * pHttpResponse = pHttpContext->GetResponse();
// Test for an error.
if (pHttpResponse != NULL)
{
// Flush the response to the client.
hr = pHttpResponse->Flush(false,true,&cbSent,&fCompletionExpected);
// Test for an error.
if (FAILED(hr))
{
// Set the error status.
pProvider->SetErrorStatus( hr );
// End additional processing.
return RQ_NOTIFICATION_FINISH_REQUEST;
}
// Clear the response.
pHttpResponse->Clear();
}
// 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_BEGIN_REQUEST,
0
);
}
Votre module doit exporter la fonction RegisterModule . Vous pouvez exporter cette fonction en créant un fichier de définition de module (.def) pour votre projet, ou vous pouvez compiler le module à l’aide du /EXPORT:RegisterModule
commutateur. Pour plus d’informations, consultez Procédure pas à pas : création d’un module HTTP Request-Level à l’aide de code natif.
Vous pouvez éventuellement compiler le code à l’aide de la __stdcall (/Gz)
convention d’appel au lieu de déclarer explicitement la convention d’appel pour chaque fonction.
Spécifications
Type | Description |
---|---|
Client | - IIS 7.0 sur Windows Vista - IIS 7.5 sur Windows 7 - IIS 8.0 sur Windows 8 - IIS 10.0 sur Windows 10 |
Serveur | - IIS 7.0 sur Windows Server 2008 - IIS 7.5 sur Windows Server 2008 R2 - IIS 8.0 sur Windows Server 2012 - IIS 8.5 sur Windows Server 2012 R2 - IIS 10.0 sur Windows Server 2016 |
Produit | - 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 |
En-tête | Httpserv.h |