HttpRequestHeaderCollection Classe

Definizione

Spazio dei nomi:

Windows.Web.Http.Headers

Fornisce una raccolta di intestazioni HTTP associate a una richiesta HTTP.

public ref class HttpRequestHeaderCollection sealed : IIterable<IKeyValuePair<Platform::String ^, Platform::String ^> ^>, IMap<Platform::String ^, Platform::String ^>, IStringable

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class HttpRequestHeaderCollection final : IIterable<IKeyValuePair<winrt::hstring, winrt::hstring const&>>, IMap<winrt::hstring, winrt::hstring const&>, IStringable

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class HttpRequestHeaderCollection : IDictionary<string,string>, IEnumerable<KeyValuePair<string,string>>, IStringable

Public NotInheritable Class HttpRequestHeaderCollection
Implements IDictionary(Of String, String), IEnumerable(Of KeyValuePair(Of String, String)), IStringable

Ereditarietà

Object Platform::Object IInspectable HttpRequestHeaderCollection

Attributi

ContractVersionAttribute MarshalingBehaviorAttribute

Implementazioni

IDictionary<String,String> IMap<Platform::String,Platform::String> IMap<winrt::hstring,winrt::hstring> IIterable<IKeyValuePair<K,V>> IEnumerable<KeyValuePair<K,V>> IEnumerable<KeyValuePair<String,String>> IIterable<IKeyValuePair<Platform::String,Platform::String>> IIterable<IKeyValuePair<winrt::hstring,winrt::hstring>> IStringable

Requisiti Windows

Famiglia di dispositivi	Windows 10 (è stato introdotto in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (è stato introdotto in v1.0)

Esempio

Il codice di esempio seguente illustra un metodo per ottenere e impostare le intestazioni di richiesta in un oggetto HttpRequestMessage usando le proprietà nell'oggetto HttpRequestHeaderCollection. Lo spazio dei nomi Windows.Web.Http.Headers include anche una serie di classi di intestazioni e valori fortemente tipizzata per intestazioni HTTP specifiche che possono essere usate per ottenere e impostare intestazioni con convalida.

using System;
using System.Collections.Generic;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.Web.Http;
using Windows.Web.Http.Headers;

        public void DemonstrateHeaderRequest()
        {
            DemonstrateHeaderRequestAccept();
            DemonstrateHeaderRequestAcceptEncoding();
            DemonstrateHeaderRequestAcceptLanguage();
            DemonstrateHeaderRequestAuthorization();
            DemonstrateHeaderRequestCacheControl();
            DemonstrateHeaderRequestConnection();
            DemonstrateHeaderRequestCookie();
            DemonstrateHeaderRequestDate();
            DemonstrateHeaderRequestFrom();
            DemonstrateHeaderRequestHost();
            DemonstrateHeaderRequestIfModifiedSince();
            DemonstrateHeaderRequestIfUnmodifiedSince();
            DemonstrateHeaderRequestMaxForwards();
            DemonstrateHeaderRequestProxyAuthorization();
            DemonstrateHeaderRequestReferer();
            DemonstrateHeaderRequestUserAgent();
        }

        public void DemonstrateHeaderRequestAccept()
        {
            var request = new HttpRequestMessage();
            bool parsedOk = false;

            // Set the header with a string.
            parsedOk = request.Headers.Accept.TryParseAdd ("audio/*");
            parsedOk = request.Headers.Accept.TryParseAdd ("audio/*; q=0.2");
            parsedOk = request.Headers.Accept.TryParseAdd ("audio/*; q=0.4; mysetting=myvalue");

            // Set the header with a strong type.
            request.Headers.Accept.Add(new HttpMediaTypeWithQualityHeaderValue("audio/*", .6));

            // Get the strong type out
            foreach (var value in request.Headers.Accept)
            {
                System.Diagnostics.Debug.WriteLine("One of the Accept values: {0}={1}", value.MediaType, value.Quality);
            }

            // The ToString() is useful for diagnostics, too.
            System.Diagnostics.Debug.WriteLine("The Accept ToString() results: {0}", request.Headers.Accept.ToString());
        }

        public void DemonstrateHeaderRequestAcceptEncoding()
        {
            var request = new HttpRequestMessage();
            bool parsedOk = false;

            // Set the header with a string.
            parsedOk = request.Headers.AcceptEncoding.TryParseAdd("compress");
            parsedOk = request.Headers.AcceptEncoding.TryParseAdd("gzip;q=1.0");

            // Set the header with a strong type.
            request.Headers.AcceptEncoding.Add(new HttpContentCodingWithQualityHeaderValue("*", 0));

            // Get the strong type out
            foreach (var value in request.Headers.AcceptEncoding)
            {
                System.Diagnostics.Debug.WriteLine("One of the AcceptEncoding values: {0}={1}", value.ContentCoding, value.Quality);
            }

            // The ToString() is useful for diagnostics, too.
            System.Diagnostics.Debug.WriteLine("The AcceptEncoding ToString() results: {0}", request.Headers.AcceptEncoding.ToString());
        }

        public void DemonstrateHeaderRequestAcceptLanguage()
        {
            var request = new HttpRequestMessage();
            bool parsedOk = false;

            // Set the header with a string.
            parsedOk = request.Headers.AcceptLanguage.TryParseAdd("da");
            parsedOk = request.Headers.AcceptLanguage.TryParseAdd("en-gb;q=0.8");

            // Set the header with a strong type.
            request.Headers.AcceptLanguage.Add(new HttpLanguageRangeWithQualityHeaderValue("en", .7));

            // Get the strong type out
            foreach (var value in request.Headers.AcceptLanguage)
            {
                System.Diagnostics.Debug.WriteLine("One of the AcceptLanguage values: {0}={1}", value.LanguageRange, value.Quality);
            }

            // The ToString() is useful for diagnostics, too.
            System.Diagnostics.Debug.WriteLine("The AcceptLanguage ToString() results: {0}", request.Headers.AcceptLanguage.ToString());
        }

        public void DemonstrateHeaderRequestAuthorization()
        {
            var request = new HttpRequestMessage();

            // Set the header with a strong type.
            string username = "user";
            string password = "password";
            var buffer = Windows.Security.Cryptography.CryptographicBuffer.ConvertStringToBinary (username + ":" + password, Windows.Security.Cryptography.BinaryStringEncoding.Utf8);
            string base64token = Windows.Security.Cryptography.CryptographicBuffer.EncodeToBase64String(buffer);
            request.Headers.Authorization = new HttpCredentialsHeaderValue("Basic", base64token);


            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("One of the Authorization values: {0}={1}", 
                request.Headers.Authorization.Scheme,
                request.Headers.Authorization.Token);

            // The ToString() is useful for diagnostics, too.
            System.Diagnostics.Debug.WriteLine("The Authorization ToString() results: {0}", request.Headers.Authorization.ToString());
        }

        public void DemonstrateHeaderRequestCacheControl()
        {
            var request = new HttpRequestMessage();
            bool parsedOk = false;

            // Set the header with a string.
            parsedOk = request.Headers.CacheControl.TryParseAdd("no-store");

            // Set the header with a strong type.
            request.Headers.CacheControl.Add(new HttpNameValueHeaderValue("max-age", "10"));

            // Get the strong type out
            foreach (var value in request.Headers.CacheControl)
            {
                System.Diagnostics.Debug.WriteLine("One of the CacheControl values: {0}={1}", value.Name, value.Value);
            }

            // The ToString() is useful for diagnostics, too.
            System.Diagnostics.Debug.WriteLine("The CacheControl ToString() results: {0}", request.Headers.CacheControl.ToString());
        }


        public void DemonstrateHeaderRequestConnection()
        {
            var request = new HttpRequestMessage();
            bool parsedOk = false;

            // Set the header with a string.
            parsedOk = request.Headers.Connection.TryParseAdd("close");

            // Set the header with a strong type.
            request.Headers.Connection.Add(new HttpConnectionOptionHeaderValue("cache-control"));

            // Get the strong type out
            foreach (var value in request.Headers.Connection)
            {
                System.Diagnostics.Debug.WriteLine("One of the Connection values: {0}", value.Token);
            }

            // The ToString() is useful for diagnostics, too.
            System.Diagnostics.Debug.WriteLine("The Connection ToString() results: {0}", request.Headers.Connection.ToString());
        }

        public void DemonstrateHeaderRequestCookie()
        {
            var request = new HttpRequestMessage();
            bool parsedOk = false;

            // Set the header with a string.
            parsedOk = request.Headers.Cookie.TryParseAdd("cookieName=cookieValue");

            // Set the header with a strong type.
            request.Headers.Cookie.Add(new HttpCookiePairHeaderValue("cookie2", "value2"));

            // Get the strong type out
            foreach (var value in request.Headers.Cookie)
            {
                System.Diagnostics.Debug.WriteLine("One of the Cookie values: {0}={1}", value.Name, value.Value);
            }

            // The ToString() is useful for diagnostics, too.
            System.Diagnostics.Debug.WriteLine("The Cookie ToString() results: {0}", request.Headers.Cookie.ToString());
        }


        public void DemonstrateHeaderRequestDate()
        {
            var request = new HttpRequestMessage();

            // This is not typically set with a string.

            // Set the header with a strong type.
            DateTimeOffset value = DateTimeOffset.UtcNow;
            request.Headers.Date = value;

            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("Date value in ticks: {0}", request.Headers.Date.Value.Ticks);

            // The ToString() is useful for diagnostics, too.
            System.Diagnostics.Debug.WriteLine("The Date ToString() results: {0}", request.Headers.Date.ToString());
        }

        public void DemonstrateHeaderRequestFrom()
        {
            var request = new HttpRequestMessage();

            // Set the header with a string.
            request.Headers.From = "person@example.com";

            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("From value: {0}", request.Headers.From);
        }

        public void DemonstrateHeaderRequestHost()
        {
            var request = new HttpRequestMessage();

            // This is not typically set with a string.

            // Set the header with a strong type.
            // HostName is in the Windows.Networking namespace.
            var value = new Windows.Networking.HostName("example.com");
            request.Headers.Host = value;

            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("Canonical Host name: {0}", request.Headers.Host.CanonicalName);

            // The ToString() is useful for diagnostics, too.
            System.Diagnostics.Debug.WriteLine("The Host ToString() results: {0}", request.Headers.Host.ToString());
        }

        public void DemonstrateHeaderRequestIfModifiedSince()
        {
            var request = new HttpRequestMessage();

            // This is not typically set with a string.

            // Set the header with a strong type.
            var value = DateTimeOffset.Now.AddDays(-1); // Since yesterday.
            request.Headers.IfModifiedSince = value;

            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("IfModifiedSince value in ticks: {0}", request.Headers.IfModifiedSince.Value.Ticks);

            // The ToString() is useful for diagnostics, too.
            System.Diagnostics.Debug.WriteLine("The IfModifiedSince ToString() results: {0}", request.Headers.IfModifiedSince.ToString());
        }

        public void DemonstrateHeaderRequestIfUnmodifiedSince()
        {
            var request = new HttpRequestMessage();

            // This is not typically set with a string.

            // Set the header with a strong type.
            var value = DateTimeOffset.Now.AddDays(-1); // Since yesterday.
            request.Headers.IfUnmodifiedSince = value;

            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("IfUnmodifiedSince value in ticks: {0}", request.Headers.IfUnmodifiedSince.Value.Ticks);

            // The ToString() is useful for diagnostics, too.
            System.Diagnostics.Debug.WriteLine("The IfUnmodfiedSince ToString() results: {0}", request.Headers.IfUnmodifiedSince.ToString());
        }

        public void DemonstrateHeaderRequestMaxForwards()
        {
            var request = new HttpRequestMessage();

            // Set the header with an integer.
            request.Headers.MaxForwards= 2;

            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("MaxForwards value: {0}", request.Headers.MaxForwards);
        }

        public void DemonstrateHeaderRequestProxyAuthorization()
        {
            var request = new HttpRequestMessage();

            // Set the header with a strong type.
            string username = "user";
            string password = "password";
            var buffer = Windows.Security.Cryptography.CryptographicBuffer.ConvertStringToBinary(username + ":" + password, Windows.Security.Cryptography.BinaryStringEncoding.Utf16LE);
            string base64token = Windows.Security.Cryptography.CryptographicBuffer.EncodeToBase64String(buffer);
            request.Headers.ProxyAuthorization = new HttpCredentialsHeaderValue("Basic", base64token);


            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("One of the ProxyAuthorixation values: {0}={1}",
                request.Headers.ProxyAuthorization.Scheme,
                request.Headers.ProxyAuthorization.Token);

            // The ToString() is useful for diagnostics, too.
            System.Diagnostics.Debug.WriteLine("The ProxyAuthorization ToString() results: {0}", request.Headers.ProxyAuthorization.ToString());
        }


        public void DemonstrateHeaderRequestReferer()
        {
            var request = new HttpRequestMessage();

            // This is not typically set with a string.

            // Set the header with a strong type.
            // Uri is either in the Windows.Foundation namespace (JavaScript and C++)
            // or in the System.Net namespace (C#).
            var value = new Uri("http://example.com/");
            request.Headers.Referer = value;

            // Get the strong type out
            System.Diagnostics.Debug.WriteLine("Referer absolute uri: {0}", request.Headers.Referer.AbsoluteUri);

            // The ToString() is useful for diagnostics, too.
            System.Diagnostics.Debug.WriteLine("The Host ToString() results: {0}", request.Headers.Referer.ToString());
        }

        public void DemonstrateHeaderRequestUserAgent()
        {
            var request = new HttpRequestMessage();
            bool parsedOk = false;

            // Set the header with a string.
            parsedOk = request.Headers.UserAgent.TryParseAdd("testprogram/1.0");

            // Set the header with a strong type.
            request.Headers.UserAgent.Add(new HttpProductInfoHeaderValue("myprogram", "2.2"));

            // Get the strong type out
            foreach (var value in request.Headers.UserAgent)
            {
                System.Diagnostics.Debug.WriteLine("One of the UserAgent values: {0} / {1}", value.Product.Name, value.Product.Version);
            }

            // The ToString() is useful for diagnostics, too.
            System.Diagnostics.Debug.WriteLine("The UserAgent ToString() results: {0}", request.Headers.UserAgent.ToString());
        }

Commenti

HttpRequestHeaderCollection è una raccolta di intestazioni HTTP associate a una richiesta HTTP. L'oggetto HttpRequestHeaderCollection può essere usato per ottenere o impostare le intestazioni specifiche in una richiesta HTTP. La maggior parte delle proprietà nell'oggetto HttpRequestHeaderCollection consente di accedere al valore di un'intestazione HTTP specifica.

La proprietà Headers in HttpRequestMessage restituisce un oggetto HttpRequestHeaderCollection. La proprietà DefaultRequestHeaders in HttpClient restituisce anche un oggetto HttpRequestHeaderCollection. Questi sono i due metodi per costruire un oggetto HttpRequestHeaderCollection.

HttpRequestHeaderCollection rappresenta le intestazioni HTTP in una richiesta HTTP che uno sviluppatore di app può impostare, non tutte le intestazioni che potrebbero essere inviate alla richiesta. HttpBaseProtocolFilter aggiungerà alcune intestazioni aggiuntive.

Le intestazioni in una richiesta HTTP possono essere modificate dallo stack sottostante. Questo è il motivo per cui un'app potrebbe voler ottenere un valore di intestazione da HttpRequestHeaderCollection dopo il completamento della richiesta.

Enumerazione della raccolta in C# o Microsoft Visual Basic

È possibile scorrere un oggetto HttpRequestHeaderCollection in C# o Microsoft Visual Basic. In molti casi, ad esempio usando la sintassi foreach , il compilatore esegue questo cast per l'utente e non è necessario eseguire il cast in IEnumerable modo esplicito. Se è necessario eseguire il cast in modo esplicito, ad esempio se si vuole chiamare GetEnumerator, eseguire il cast dell'oggetto raccolta in IEnumerable<T> con keyValuePair di String e String come vincolo.

Proprietà

Accept	Ottiene l'oggetto HttpMediaTypeWithQualityHeaderValueCollection degli oggetti HttpMediaTypeWithQualityHeaderValue che rappresentano il valore di un'intestazione HTTP Accept in una richiesta HTTP.
AcceptEncoding	Ottiene l'oggetto HttpContentCodingWithQualityHeaderValueCollection degli oggetti HttpContentCodingWithQualityHeaderValue che rappresentano il valore di un'intestazione HTTP Accept-Encoding in una richiesta HTTP.
AcceptLanguage	Ottiene l'oggetto HttpLanguageRangeWithQualityHeaderValueCollection degli oggetti HttpLanguageRangeWithQualityHeaderValue che rappresentano il valore di un'intestazione HTTP Accept-Language in una richiesta HTTP.
Authorization	Ottiene o imposta l'oggetto HttpCredentialsHeaderValue che rappresenta il valore di un'intestazione HTTP di autorizzazione in una richiesta HTTP.
CacheControl	Ottiene l'oggetto HttpCacheDirectiveHeaderValueCollection che rappresenta il valore di un'intestazione HTTP cache-Control in una richiesta HTTP.
Connection	Ottiene l'oggetto HttpConnectionOptionHeaderValueCollection degli oggetti HttpConnectionOptionHeaderValue che rappresentano il valore di un'intestazione HTTP connection in una richiesta HTTP.
Cookie	Ottiene l'oggetto HttpCookiePairHeaderValueCollection di oggetti HttpCookiePairHeaderValue che rappresentano il valore di un'intestazione HTTP Cookie inviata su una richiesta HTTP.
Date	Ottiene o imposta l'oggetto DateTime che rappresenta il valore di un'intestazione HTTP Date in una richiesta HTTP.
Expect	Ottiene l'oggetto HttpExpectationHeaderValueCollection degli oggetti HttpExpectationHeaderValue che rappresentano il valore di un'intestazione HTTP Expect in una richiesta HTTP.
From	Ottiene o imposta l'oggetto String che rappresenta il valore di un'intestazione From HTTP in una richiesta HTTP.
Host	Ottiene o imposta il nome host che rappresenta il valore di un'intestazione HTTP host in una richiesta HTTP.
IfModifiedSince	Ottiene o imposta l'oggetto DateTime che rappresenta il valore di un'intestazione HTTP If-Modified-Since in una richiesta HTTP.
IfUnmodifiedSince	Ottiene o imposta l'oggetto DateTime che rappresenta il valore di un'intestazione HTTP If-Unmodified-Since in una richiesta HTTP.
MaxForwards	Ottiene o imposta un valore intero che rappresenta il valore di un'intestazione HTTP Max-Forwards in una richiesta HTTP.
ProxyAuthorization	Ottiene o imposta l'oggetto HttpCredentialsHeaderValue che rappresenta il valore di un'intestazione HTTP di autorizzazione proxy in una richiesta HTTP.
Referer	Ottiene o imposta l'URI che rappresenta il valore di un'intestazione HTTP referer in una richiesta HTTP.
Size	Ottiene il numero di oggetti in HttpRequestHeaderCollection.
TransferEncoding	Ottiene l'oggetto HttpTransferCodingHeaderValueCollection di oggetti HttpTransferCodingHeaderValue che rappresentano il valore di un'intestazione HTTP Transfer-Encoding in una richiesta HTTP.
UserAgent	Ottiene l'oggetto HttpProductInfoHeaderValueCollection degli oggetti HttpProductInfoHeaderValue che rappresentano il valore di un'intestazione HTTP user-agent in una richiesta HTTP.

Metodi

Append(String, String)	Aggiunge un nuovo elemento alla fine di HttpRequestHeaderCollection.
Clear()	Rimuove tutti gli oggetti da HttpRequestHeaderCollection.
First()	Recupera un iteratore al primo elemento in HttpRequestHeaderCollection.
GetView()	Restituisce una visualizzazione non modificabile di HttpRequestHeaderCollection.
HasKey(String)	Determina se HttpRequestHeaderCollection contiene la chiave specificata.
Insert(String, String)	Inserisce o sostituisce un elemento in HttpRequestHeaderCollection con la chiave e il valore specificati.
Lookup(String)	Trova un elemento in HttpRequestHeaderCollection , se esistente.
Remove(String)	Rimuove un oggetto specifico da HttpRequestHeaderCollection.
ToString()	Restituisce una stringa che rappresenta l'oggetto HttpRequestHeaderCollection corrente.
TryAppendWithoutValidation(String, String)	Provare ad aggiungere l'elemento specificato a HttpRequestHeaderCollection senza convalida.

Vedi anche

• DefaultRequestHeaders
• Headers
• HttpBaseProtocolFilter
• HttpClient
• HttpRequestMessage
• IMap<K,V>
• IIterable<T>
• IStringable