IHttpSysRequestPropertyFeature.TryGetRequestProperty Metoda
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Načte libovolnou hodnotu HTTP_REQUEST_PROPERTY z HTTP.SYS pomocí rozhraní HTTPQueryRequestProperty Windows API.
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
Parametry
- propertyId
- Int32
Identifikátor HTTP_REQUEST_PROPERTY, který se má dotazovat. Sada podporovaných hodnot je definována výčtem HTTP_REQUEST_PROPERTY v http.h; volající je zodpovědný za parsování bajtů vrácených pomocí output odpovídající nativní struktury.
- qualifier
- ReadOnlySpan<Byte>
Volitelné kvalifikátory specifické pro vlastnost. Předání prázdného rozsahu pro vlastnosti, které nevyžadují kvalifikátor; Při volání základního rozhraní API se namapuje na ukazatel null.
Cílová vyrovnávací paměť, která přijímá hodnotu vlastnosti. Předání prázdného rozsahu pro dotaz na požadovanou velikost vyrovnávací paměti prostřednictvím bytesReturned.
- bytesReturned
- Int32
Vrátí počet bajtů zapsaných do output.
Pokud output byl příliš malý (nebo prázdný), vrátí velikost vyrovnávací paměti potřebnou k uložení hodnoty.
Návraty
Hodnota True, pokud byla vlastnost úspěšně načtena do output.
False, pokud output není dostatečně velký k uložení hodnoty; v takovém případě bytesReturned obsahuje požadovanou velikost vyrovnávací paměti.
V případě jakéhokoli jiného selhání se vyvolá výjimka.
Výjimky
Jakákoli chyba HttpSys s výjimkou ERROR_INSUFFICIENT_BUFFER nebo ERROR_MORE_DATA.
Pokud nainstalované Windows rozhraní HTTP Server API nepodporuje HttpQueryRequestProperty.
Poznámky
Pokud požadovaná velikost vyrovnávací paměti není předem známa, nejprve zavolejte tuto metodu s prázdnou output , aby se načetla požadovaná velikost, bytesReturneda pak přidělte tolik bajtů a zkuste dotaz zopakovat.