HttpConnectionOptionHeaderValueCollection HttpConnectionOptionHeaderValueCollection HttpConnectionOptionHeaderValueCollection HttpConnectionOptionHeaderValueCollection Class

Definition

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

public : sealed class HttpConnectionOptionHeaderValueCollection : IIterable<HttpConnectionOptionHeaderValue>, IVector<HttpConnectionOptionHeaderValue>, IStringable, IHttpConnectionOptionHeaderValueCollection
public sealed class HttpConnectionOptionHeaderValueCollection : IEnumerable<HttpConnectionOptionHeaderValue>, IList<HttpConnectionOptionHeaderValue>, IStringable, IHttpConnectionOptionHeaderValueCollection
Public NotInheritable Class HttpConnectionOptionHeaderValueCollection Implements IEnumerable<HttpConnectionOptionHeaderValue>, IList<HttpConnectionOptionHeaderValue>, IStringable, IHttpConnectionOptionHeaderValueCollection
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

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 with an HttpConnectionOptionHeaderValue constraint.

Properties

Item[Int32] Item[Int32] Item[Int32] Item[Int32]

Gets or sets the element at the specified index.

This member is not implemented in C++
T this[int index] { get; set; }
Property Item(index As Integer) As T
T this[int index] { get; set; }
Parameters
index

The zero-based index of the element to get or set.

Value
T T T T

The element at the specified index.

Exceptions

index is not a valid index in the System.Collections.Generic.IList`1.

The property is set and the System.Collections.Generic.IList`1 is read-only.

Size Size Size Size

Gets the number of HttpConnectionOptionHeaderValue objects in the collection.

public : unsigned int Size { get; }
This member is not implemented in C#
This member is not implemented in VB.Net
var uint = httpConnectionOptionHeaderValueCollection.size;
Value
unsigned int uint uint uint

The number of HttpConnectionOptionHeaderValue objects in the HttpConnectionOptionHeaderValueCollection.

Methods

Append(HttpConnectionOptionHeaderValue) Append(HttpConnectionOptionHeaderValue) Append(HttpConnectionOptionHeaderValue) Append(HttpConnectionOptionHeaderValue)

Adds a new HttpConnectionOptionHeaderValue item to the end of the collection.

public : void Append(HttpConnectionOptionHeaderValue value)
This member is not implemented in C#
This member is not implemented in VB.Net
httpConnectionOptionHeaderValueCollection.append(value);
Parameters

Clear() Clear() Clear() Clear()

Removes all HttpConnectionOptionHeaderValue objects from the collection.

public : void Clear()
This member is not implemented in C#
This member is not implemented in VB.Net
httpConnectionOptionHeaderValueCollection.clear();

First() First() First() First()

Retrieves an iterator to the first HttpConnectionOptionHeaderValue item in the collection.

public : IIterator<HttpConnectionOptionHeaderValue> First()
This member is not implemented in C#
This member is not implemented in VB.Net
var iIterator = httpConnectionOptionHeaderValueCollection.first();
Returns

GetAt(UInt32) GetAt(UInt32) GetAt(UInt32) GetAt(UInt32)

Returns the HttpConnectionOptionHeaderValue at the specified index in the collection.

public : HttpConnectionOptionHeaderValue GetAt(unsigned int index)
This member is not implemented in C#
This member is not implemented in VB.Net
var httpConnectionOptionHeaderValue = httpConnectionOptionHeaderValueCollection.getAt(index);
Parameters
index
unsigned int UInt32 UInt32 UInt32

The zero-based index of a specified item in the HttpConnectionOptionHeaderValueCollection.

Returns

GetEnumerator() GetEnumerator() GetEnumerator() GetEnumerator()

Returns an enumerator that iterates through the collection.

This member is not implemented in C++
IEnumerator<T> GetEnumerator()
Function GetEnumerator As IEnumerator(Of T)
IEnumerator<T> GetEnumerator()
Returns

An enumerator that can be used to iterate through the collection.

GetMany(UInt32, HttpConnectionOptionHeaderValue[]) GetMany(UInt32, HttpConnectionOptionHeaderValue[]) GetMany(UInt32, HttpConnectionOptionHeaderValue[]) GetMany(UInt32, HttpConnectionOptionHeaderValue[])

Retrieves the HttpConnectionOptionHeaderValue items that start at the specified index in the collection.

public : unsigned int GetMany(unsigned int startIndex, HttpConnectionOptionHeaderValue[] items)
This member is not implemented in C#
This member is not implemented in VB.Net
var uint = httpConnectionOptionHeaderValueCollection.getMany(startIndex, items);
Parameters
startIndex
unsigned int UInt32 UInt32 UInt32

The zero-based index of the start of the HttpConnectionOptionHeaderValue items in the HttpConnectionOptionHeaderValueCollection.

items
HttpConnectionOptionHeaderValue[] HttpConnectionOptionHeaderValue[] HttpConnectionOptionHeaderValue[] HttpConnectionOptionHeaderValue[]

An array of HttpConnectionOptionHeaderValue items that start at startIndex in the HttpConnectionOptionHeaderValueCollection.

Returns
unsigned int uint uint uint

The number of HttpConnectionOptionHeaderValue items retrieved.

GetView() GetView() GetView() GetView()

Returns an immutable view of the HttpConnectionOptionHeaderValueCollection.

public : IVectorView<HttpConnectionOptionHeaderValue> GetView()
This member is not implemented in C#
This member is not implemented in VB.Net
var iVectorView = httpConnectionOptionHeaderValueCollection.getView();
Returns
IVectorView<HttpConnectionOptionHeaderValue> IReadOnlyList<HttpConnectionOptionHeaderValue> IReadOnlyList<HttpConnectionOptionHeaderValue> IReadOnlyList<HttpConnectionOptionHeaderValue>

The view of the HttpConnectionOptionHeaderValueCollection.

IndexOf(T) IndexOf(T) IndexOf(T) IndexOf(T)

Determines the index of a specific item in the System.Collections.Generic.IList`1.

This member is not implemented in C++
int IndexOf(T item)
Function IndexOf(item As T) As Integer
int IndexOf(T item)
Parameters
item
T T T T

The object to locate in the System.Collections.Generic.IList`1.

Returns

The index of item if found in the list; otherwise, -1.

IndexOf(HttpConnectionOptionHeaderValue, UInt32) IndexOf(HttpConnectionOptionHeaderValue, UInt32) IndexOf(HttpConnectionOptionHeaderValue, UInt32) IndexOf(HttpConnectionOptionHeaderValue, UInt32)

Retrieves the index of an HttpConnectionOptionHeaderValue in the collection.

public : Platform::Boolean IndexOf(HttpConnectionOptionHeaderValue value, unsigned int index)
This member is not implemented in C#
This member is not implemented in VB.Net
var bool = httpConnectionOptionHeaderValueCollection.indexOf(value, index);
Parameters
index
unsigned int UInt32 UInt32 UInt32

The index of the HttpConnectionOptionHeaderValue in the HttpConnectionOptionHeaderValueCollection.

If the item is found, this is the zero-based index of the item; otherwise, this parameter is 0.

Returns
Platform::Boolean bool bool bool

Indicates whether the item is found.

true if the HttpConnectionOptionHeaderValue item is found; otherwise, false.

Insert(Int32, T) Insert(Int32, T) Insert(Int32, T) Insert(Int32, T)

Inserts an item to the System.Collections.Generic.IList`1 at the specified index.

This member is not implemented in C++
void Insert(int index, T item)
Sub Insert(index As Integer, item As T)
void Insert(int index, T item)
Parameters
index

The zero-based index at which item should be inserted.

item
T T T T

The object to insert into the System.Collections.Generic.IList`1.

Exceptions

index is not a valid index in the System.Collections.Generic.IList`1.

The System.Collections.Generic.IList`1 is read-only.

InsertAt(UInt32, HttpConnectionOptionHeaderValue) InsertAt(UInt32, HttpConnectionOptionHeaderValue) InsertAt(UInt32, HttpConnectionOptionHeaderValue) InsertAt(UInt32, HttpConnectionOptionHeaderValue)

Inserts an HttpConnectionOptionHeaderValue into the collection at the specified index.

public : void InsertAt(unsigned int index, HttpConnectionOptionHeaderValue value)
This member is not implemented in C#
This member is not implemented in VB.Net
httpConnectionOptionHeaderValueCollection.insertAt(index, value);
Parameters
index
unsigned int UInt32 UInt32 UInt32

The zero-based index at which value should be inserted.

ParseAdd(String) ParseAdd(String) ParseAdd(String) ParseAdd(String)

Parses and adds an entry to the HttpConnectionOptionHeaderValueCollection.

public : void ParseAdd(Platform::String input)
public void ParseAdd(String input)
Public Function ParseAdd(input As String) As void
httpConnectionOptionHeaderValueCollection.parseAdd(input);
Parameters
input
Platform::String String String String

The entry to add.

Remarks

Below are exceptions that this function throws.

E_INVALIDARG

The input parameter is null (Nothing in Visual Basic).

The input parameter is not a valid value for the Connection HTTP header.

RemoveAt(Int32) RemoveAt(Int32) RemoveAt(Int32) RemoveAt(Int32)

Removes the System.Collections.Generic.IList`1 item at the specified index.

This member is not implemented in C++
void RemoveAt(int index)
Sub RemoveAt(index As Integer)
void RemoveAt(int index)
Parameters
index

The zero-based index of the item to remove.

Exceptions

index is not a valid index in the System.Collections.Generic.IList`1.

The System.Collections.Generic.IList`1 is read-only.

RemoveAt(UInt32) RemoveAt(UInt32) RemoveAt(UInt32) RemoveAt(UInt32)

Removes the entry at the specified index from the HttpConnectionOptionHeaderValueCollection.

public : void RemoveAt(unsigned int index)
This member is not implemented in C#
This member is not implemented in VB.Net
httpConnectionOptionHeaderValueCollection.removeAt(index);
Parameters
index
unsigned int UInt32 UInt32 UInt32

The index of the entry to remove.

RemoveAtEnd() RemoveAtEnd() RemoveAtEnd() RemoveAtEnd()

Removes the last HttpConnectionOptionHeaderValue item from the collection.

public : void RemoveAtEnd()
This member is not implemented in C#
This member is not implemented in VB.Net
httpConnectionOptionHeaderValueCollection.removeAtEnd();

ReplaceAll(HttpConnectionOptionHeaderValue[]) ReplaceAll(HttpConnectionOptionHeaderValue[]) ReplaceAll(HttpConnectionOptionHeaderValue[]) ReplaceAll(HttpConnectionOptionHeaderValue[])

Replaces all the HttpConnectionOptionHeaderValue items in the collection with the specified HttpConnectionOptionHeaderValue items.

public : void ReplaceAll(HttpConnectionOptionHeaderValue[] items)
This member is not implemented in C#
This member is not implemented in VB.Net
httpConnectionOptionHeaderValueCollection.replaceAll(items);
Parameters
items
HttpConnectionOptionHeaderValue[] HttpConnectionOptionHeaderValue[] HttpConnectionOptionHeaderValue[] HttpConnectionOptionHeaderValue[]

The collection of HttpConnectionOptionHeaderValue items to add to the collection.

SetAt(UInt32, HttpConnectionOptionHeaderValue) SetAt(UInt32, HttpConnectionOptionHeaderValue) SetAt(UInt32, HttpConnectionOptionHeaderValue) SetAt(UInt32, HttpConnectionOptionHeaderValue)

Sets the HttpConnectionOptionHeaderValue at the specified index in the collection.

public : void SetAt(unsigned int index, HttpConnectionOptionHeaderValue value)
This member is not implemented in C#
This member is not implemented in VB.Net
httpConnectionOptionHeaderValueCollection.setAt(index, value);
Parameters
index
unsigned int UInt32 UInt32 UInt32

The zero-based index at which to set the HttpConnectionOptionHeaderValue.

ToString() ToString() ToString() ToString()

Returns a string that represents the current HttpConnectionOptionHeaderValueCollection object.

public : Platform::String ToString()
public string ToString()
Public Function ToString() As string
var string = httpConnectionOptionHeaderValueCollection.toString();
Returns
Platform::String string string string

A string that represents the current object.

TryParseAdd(String) TryParseAdd(String) TryParseAdd(String) TryParseAdd(String)

Tries to parse and add the specified item to the HttpConnectionOptionHeaderValueCollection.

public : Platform::Boolean TryParseAdd(Platform::String input)
public bool TryParseAdd(String input)
Public Function TryParseAdd(input As String) As bool
var bool = httpConnectionOptionHeaderValueCollection.tryParseAdd(input);
Parameters
input
Platform::String String String String

The item to parse and add.

Returns
Platform::Boolean bool bool bool

true if the item successfully parsed and was added; otherwise false.

See Also