Функция HttpSetRequestProperty (http.h)
Функция HttpSetRequestProperty задает новое свойство или изменяет существующее свойство в указанном запросе.
Синтаксис
HTTPAPI_LINKAGE ULONG HttpSetRequestProperty(
[in] HANDLE RequestQueueHandle,
[in] HTTP_OPAQUE_ID Id,
[in] HTTP_REQUEST_PROPERTY PropertyId,
[in] PVOID Input,
[in] ULONG InputPropertySize,
[in] LPOVERLAPPED Overlapped
);
Параметры
[in] RequestQueueHandle
Дескриптор очереди запросов, в которой был получен запрос. Создается очередь запросов, а ее дескриптор возвращается вызовом функции HttpCreateRequestQueue .
[in] Id
Непрозрачный идентификатор запроса. Этот идентификатор находится в элементе RequestIdструктуры HTTP_REQUEST , возвращаемой HttpReceiveHttpRequest.
[in] PropertyId
Член перечисления HTTP_REQUEST_PROPERTY , описывающий заданный тип свойства. Это должен быть один из следующих вариантов:
| Свойство | Значение | | HttpRequestPropertyStreamError | Задает ошибку потока в запросе. |
[in] Input
Указатель на буфер, содержащий сведения о свойстве.
Он должен указывать на один из следующих типов сведений о свойствах, основанных на заданном свойстве.
| Свойство | Тип конфигурации | | HttpRequestPropertyStreamError | Структура HTTP_REQUEST_PROPERTY_STREAM_ERROR |
[in] InputPropertySize
Длина (в байтах) буфера, на который указывает параметр Input .
[in] Overlapped
Для асинхронных вызовов задайте pOverlapped так, чтобы он указывал на структуру OVERLAPPED ; для синхронных вызовов задайте значение NULL.
Синхронный вызов блокируется до завершения операции, в то время как асинхронный вызов немедленно возвращает ERROR_IO_PENDING , а вызывающее приложение затем использует порты getOverlappedResult или завершения ввода-вывода, чтобы определить, когда операция будет завершена. Дополнительные сведения об использовании структур OVERLAPPED для синхронизации см. в разделе Синхронизация и перекрытие входных и выходных данных.
Возвращаемое значение
Если функция выполняется успешно, она возвращает ERROR_SUCCESS.
Если функция завершается сбоем, она возвращает код системной ошибки.
Требования
| Целевая платформа | Windows |
| Header | http.h |
| Библиотека | Httpapi.lib |
| DLL | Httpapi.dll |