Функция HttpFlushResponseCache (http.h)
Функция HttpFlushResponseCache удаляет из кэша API HTTP-сервера, связанного с заданной очередью запросов, все фрагменты ответа с именем, часть сайта которой соответствует указанному urlPrefix. Ранее приложение должно вызывать HttpAddUrl или HttpAddUrlToUrlGroup , чтобы добавить этот urlPrefix или допустимый префикс в очередь запросов, а затем вызвать HttpAddFragmentToCache для кэширования связанного фрагмента ответа или фрагментов.
Синтаксис
HTTPAPI_LINKAGE ULONG HttpFlushResponseCache(
[in] HANDLE RequestQueueHandle,
[in] PCWSTR UrlPrefix,
[in] ULONG Flags,
[in] LPOVERLAPPED Overlapped
);
Параметры
[in] RequestQueueHandle
Дескриптор очереди запросов, с которой связан этот кэш. Создается очередь запросов, а ее дескриптор возвращается вызовом функции HttpCreateRequestQueue .
Windows Server 2003 с пакетом обновления 1 (SP1) и Windows XP с пакетом обновления 2 (SP2): Дескриптор очереди запросов создается функцией HttpCreateHttpHandle .
[in] UrlPrefix
Указатель на строку UrlPrefix для сопоставления с частью сайта имен фрагментов. Приложение должно было ранее вызывать HttpAddUrl , чтобы добавить этот urlPrefix или допустимый префикс его в очередь запросов, а затем вызвать HttpAddFragmentToCache для кэширования связанного фрагмента ответа.
[in] Flags
Этот параметр может содержать следующий флаг:
HTTP_FLUSH_RESPONSE_FLAG_RECURSIVE
Вызывает удаление фрагментов ответа с именами, в которых часть сайта является иерархическим потомком указанного UrlPrefix, будут удалены из кэша фрагментов, в дополнение к тем фрагментам, которые имеют непосредственно совпадающие части сайта.
[in] Overlapped
Для асинхронных вызовов задайте для параметра pOverlapped значение , указывающее на структуру OVERLAPPED , а для синхронных вызовов — значение NULL.
Синхронный вызов блокируется до завершения операции кэша, тогда как асинхронный вызов немедленно возвращает ERROR_IO_PENDING, а вызывающее приложение затем использует порты getOverlappedResult или завершения ввода-вывода, чтобы определить, когда операция завершена. Дополнительные сведения об использовании структур OVERLAPPED для синхронизации см. в разделе Синхронизация и перекрытие входных и выходных данных.
Возвращаемое значение
Если функция выполнена успешно, возвращаемое значение будет NO_ERROR.
Если функция используется асинхронно, возвращаемое значение ERROR_IO_PENDING указывает, что запрос кэша помещается в очередь и завершается позже с помощью обычных перекрывающихся механизмов завершения ввода-вывода.
Если функция завершается сбоем, возвращается один из следующих кодов ошибок.
| Значение | Значение |
|---|---|
|
Один из параметров недопустим. |
|
Код системной ошибки, определенный в WinError.h. |
Требования
| Минимальная версия клиента | Windows Vista, Windows XP с пакетом обновления 2 (SP2) [только классические приложения] |
| Минимальная версия сервера | Windows Server 2003 [только классические приложения] |
| Целевая платформа | Windows |
| Header | http.h |
| Библиотека | Httpapi.lib |
| DLL | Httpapi.dll |