IHttpResponse::Flush メソッド
応答バッファー内の既存のコンテンツをクライアントに送信します。
構文
virtual HRESULT Flush(
IN BOOL fAsync,
IN BOOL fMoreData,
OUT DWORD* pcbSent,
OUT BOOL* pfCompletionExpected = NULL
) = 0;
パラメーター
fAsync
[IN] true 操作を非同期的に完了する場合は 。それ以外の場合は false。
fMoreData
[IN] true この応答でより多くのデータを送信する場合。それ以外の場合は false。
pcbSent
[OUT]クライアントに DWORD 送信されたバイト数を受け取る へのポインター。
pfCompletionExpected
[OUT]非同期入力候補がこの呼び出しに対して保留中かどうかを受け取るブール値へのポインター。
戻り値
HRESULT。 有効な値を次の表に示しますが、これ以外にもあります。
| 値 | 説明 |
|---|---|
| S_OK | 操作が成功したことを示します。 |
| ERROR_INVALID_DATA | データが無効であることを示します。 |
| ERROR_NOT_ENOUGH_MEMORY | 操作を実行するためのメモリが不足していることを示します。 |
解説
メソッドは Flush 、現在使用可能な応答をクライアントに送信します。 少なくとも、応答には状態ヘッダーが含まれますが、 メソッドを呼び出すときに存在する応答バッファーも含まれます。
メソッドのfMoreData呼び出し後にさらにデータが返される場合は パラメーターを Flush にtrue設定し、残りのデータがない場合は を にfalse設定fMoreDataします。
メソッドでは Flush 、同期操作と非同期操作がサポートされています。 操作が非同期の場合は パラメーターを fAsync にtrue設定し、操作が同期の場合は にfalse設定fAsyncして、操作モードを指定します。
注意
このメソッドを非同期的に呼び出す場合は、呼び出しの直後に を返す必要があります。
例
次のコード例では、 メソッドを使用して現在の Flush 応答をクライアントに送信する方法を示します。 メソッドは Flush 応答ヘッダーをクライアントに送信したため、 Clear メソッドの 後続の呼び出しは無効になります。
#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
);
}
モジュールで RegisterModule 関数をエクスポートする必要があります。 この関数をエクスポートするには、プロジェクトのモジュール定義 (.def) ファイルを作成するか、 スイッチを使用してモジュールを /EXPORT:RegisterModule コンパイルします。 詳細については、「 チュートリアル: ネイティブ コードを使用したRequest-Level HTTP モジュールの作成」を参照してください。
必要に応じて、各関数の呼び出し規約を __stdcall (/Gz) 明示的に宣言するのではなく、呼び出し規約を使用してコードをコンパイルできます。
要件
| Type | 説明 |
|---|---|
| Client | - Windows Vista 上の IIS 7.0 - Windows 7 上の IIS 7.5 - Windows 8 上の IIS 8.0 - Windows 10の IIS 10.0 |
| サーバー | - Windows Server 2008 の IIS 7.0 - Windows Server 2008 R2 の IIS 7.5 - Windows Server 2012 の IIS 8.0 - Windows Server 2012 R2 の IIS 8.5 - Windows Server 2016の IIS 10.0 |
| 製品 | - 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 |