HttpConnectionOptionHeaderValueCollection Class

Definition

Namespace:

Windows.Web.Http.Headers

Represents the value of the Connection HTTP header on an HTTP request.

public ref class HttpConnectionOptionHeaderValueCollection sealed : IIterable<HttpConnectionOptionHeaderValue ^>, IVector<HttpConnectionOptionHeaderValue ^>, IStringable

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class HttpConnectionOptionHeaderValueCollection final : IIterable<HttpConnectionOptionHeaderValue>, IVector<HttpConnectionOptionHeaderValue>, IStringable

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class HttpConnectionOptionHeaderValueCollection : IEnumerable<HttpConnectionOptionHeaderValue>, IList<HttpConnectionOptionHeaderValue>, IStringable

Public NotInheritable Class HttpConnectionOptionHeaderValueCollection
Implements IEnumerable(Of HttpConnectionOptionHeaderValue), IList(Of HttpConnectionOptionHeaderValue), IStringable

Inheritance

Object Platform::Object IInspectable HttpConnectionOptionHeaderValueCollection

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Implements

IIterable<T> IEnumerable<T> IIterable<HttpConnectionOptionHeaderValue> IEnumerable<HttpConnectionOptionHeaderValue> IVector<HttpConnectionOptionHeaderValue> IList<HttpConnectionOptionHeaderValue> IStringable

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v1.0)

Examples

The following sample code shows a method to get and set the Connection HTTP header on an HttpRequestMessage object using the properties and methods on the HttpConnectionOptionHeaderValueCollection and HttpConnectionOptionHeaderValue classes.

using System;
using Windows.Web.Http;
using Windows.Web.Http.Headers;

        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());
        }

Remarks

The HttpConnectionOptionHeaderValueCollection represents the value of the Connection HTTP header on an HTTP request.

The HttpConnectionOptionHeaderValueCollection is a collection of HttpConnectionOptionHeaderValue objects used for connection information on the HTTP Connection header.

The Connection property on the HttpRequestHeaderCollection returns an HttpConnectionOptionHeaderValueCollection object.

Collection member lists

For JavaScript, HttpConnectionOptionHeaderValueCollection has the members shown in the member lists. In addition, HttpConnectionOptionHeaderValueCollection supports members of Array.prototype and using an index to access items.

Enumerating the collection in C# or Microsoft Visual Basic

You can iterate through an HttpConnectionOptionHeaderValueCollection object in C# or Microsoft Visual Basic. In many cases, such as using foreach syntax, the compiler does this casting for you and you won't need to cast to IEnumerable<HttpConnectionOptionHeaderValue> explicitly. If you do need to cast explicitly, for example if you want to call GetEnumerator, cast the collection object to IEnumerable<T> with an HttpConnectionOptionHeaderValue constraint.

Properties

Size	Gets the number of HttpConnectionOptionHeaderValue objects in the collection.

Methods

Append(HttpConnectionOptionHeaderValue)	Adds a new HttpConnectionOptionHeaderValue item to the end of the collection.
Clear()	Removes all HttpConnectionOptionHeaderValue objects from the collection.
First()	Retrieves an iterator to the first HttpConnectionOptionHeaderValue item in the collection.
GetAt(UInt32)	Returns the HttpConnectionOptionHeaderValue at the specified index in the collection.
GetMany(UInt32, HttpConnectionOptionHeaderValue[])	Retrieves the HttpConnectionOptionHeaderValue items that start at the specified index in the collection.
GetView()	Returns an immutable view of the HttpConnectionOptionHeaderValueCollection.
IndexOf(HttpConnectionOptionHeaderValue, UInt32)	Retrieves the index of an HttpConnectionOptionHeaderValue in the collection.
InsertAt(UInt32, HttpConnectionOptionHeaderValue)	Inserts an HttpConnectionOptionHeaderValue into the collection at the specified index.
ParseAdd(String)	Parses and adds an entry to the HttpConnectionOptionHeaderValueCollection.
RemoveAt(UInt32)	Removes the entry at the specified index from the HttpConnectionOptionHeaderValueCollection.
RemoveAtEnd()	Removes the last HttpConnectionOptionHeaderValue item from the collection.
ReplaceAll(HttpConnectionOptionHeaderValue[])	Replaces all the HttpConnectionOptionHeaderValue items in the collection with the specified HttpConnectionOptionHeaderValue items.
SetAt(UInt32, HttpConnectionOptionHeaderValue)	Sets the HttpConnectionOptionHeaderValue at the specified index in the collection.
ToString()	Returns a string that represents the current HttpConnectionOptionHeaderValueCollection object.
TryParseAdd(String)	Tries to parse and add the specified item to the HttpConnectionOptionHeaderValueCollection.

See also

• Connection
• HttpConnectionOptionHeaderValue
• HttpRequestHeaderCollection
• HttpRequestMessage
• IIterable<T>
• IStringable
• IVector<T>