Язык

IHttpSysRequestPropertyFeature.TryGetRequestProperty Метод

Определение

Считывает произвольное значение HTTP_REQUEST_PROPERTY из HTTP.SYS с помощью API Windows HttpQueryRequestProperty.

public virtual bool TryGetRequestProperty(int propertyId, ReadOnlySpan<byte> qualifier, Span<byte> output, out int bytesReturned);
abstract member TryGetRequestProperty : int * ReadOnlySpan<byte> * Span<byte> * int -> bool
override this.TryGetRequestProperty : int * ReadOnlySpan<byte> * Span<byte> * int -> bool
Public Overridable Function TryGetRequestProperty (propertyId As Integer, qualifier As ReadOnlySpan(Of Byte), output As Span(Of Byte), ByRef bytesReturned As Integer) As Boolean

Параметры

propertyId
Int32

Идентификатор HTTP_REQUEST_PROPERTY для запроса. Набор поддерживаемых значений определяется HTTP_REQUEST_PROPERTY перечислением; http.hвызывающий отвечает за синтаксический анализ байтов, возвращаемых с output помощью соответствующей собственной структуры.

qualifier
ReadOnlySpan<Byte>

Необязательный квалификатор для конкретного свойства байт. Передайте пустой диапазон свойств, для которых не требуется квалификатор; при вызове базового API он будет сопоставлен с указателем null.

output
Span<Byte>

Целевой буфер, получающий значение свойства. Передайте пустой диапазон для запроса требуемого размера буфера.bytesReturned

bytesReturned
Int32

Возвращает число байтов, записанных outputв . Если output значение было слишком небольшим (или пустым), возвращает размер буфера, необходимый для хранения значения.

Возвращаемое значение

Значение true, если свойство успешно считывалось output. Значение false, если output оно недостаточно для хранения значения; в этом случае bytesReturned содержит требуемый размер буфера. Для любого другого сбоя создается исключение.

Исключения

Любая ошибка HttpSys, за исключением ERROR_INSUFFICIENT_BUFFER или ERROR_MORE_DATA.

Если установленный Windows API HTTP-сервера не поддерживает HttpQueryRequestProperty.

Комментарии

Если требуемый размер буфера не известен заранее, сначала вызовите этот метод с пустым output , чтобы получить требуемый размер bytesReturned, а затем выделите столько байтов и повторите запрос.

Применяется к