Http​Cookie​Pair​Header​Value​Collection Http​Cookie​Pair​Header​Value​Collection Http​Cookie​Pair​Header​Value​Collection Class

Definition

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

public sealed class HttpCookiePairHeaderValueCollection : IIterable, IVector, IStringable, IHttpCookiePairHeaderValueCollectionpublic sealed class HttpCookiePairHeaderValueCollection : IEnumerable, IList, IStringable, IHttpCookiePairHeaderValueCollectionPublic NotInheritable Class HttpCookiePairHeaderValueCollection Implements IEnumerable, IList, IStringable, IHttpCookiePairHeaderValueCollection
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The HttpCookiePairHeaderValueCollection class represents the value of the Cookie HTTP header on an HTTP request.

The HttpCookiePairHeaderValueCollection provides a collection container for instances of the HttpCookiePairHeaderValue class used for cookie information in the Cookie HTTP header.

The Cookie property on the HttpRequestHeaderCollection returns an HttpCookiePairHeaderValueCollection object

Examples

The following sample code shows a method to get and set the Cookie HTTP header on an HttpRequestMessage object using the properties and methods on the HttpCookiePairHeaderValueCollection and HttpCookiePairHeaderValue classes.

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

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

Properties

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
Parameters
index
System.Int32 System.Int32 System.Int32

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

Value
T T T

The element at the specified index.

Attributes
Exceptions
System.ArgumentOutOfRangeException System.ArgumentOutOfRangeException System.ArgumentOutOfRangeException

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

System.NotSupportedException System.NotSupportedException System.NotSupportedException

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

See Also
System.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnly

Size Size Size

Gets the number of HttpCookiePairHeaderValue objects in the collection.

public unsigned short Size { get; }This member is not implemented in C#This member is not implemented in VB.Net
Value
uint uint uint

The number of HttpCookiePairHeaderValue objects in the HttpCookiePairHeaderValueCollection.

Attributes

Methods

Append(HttpCookiePairHeaderValue) Append(HttpCookiePairHeaderValue) Append(HttpCookiePairHeaderValue)

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

public void Append(HttpCookiePairHeaderValue value)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
Attributes

Clear() Clear() Clear()

Removes all objects from the collection.

public void Clear()This member is not implemented in C#This member is not implemented in VB.Net
Attributes

First() First() First()

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

public IIterator<HttpCookiePairHeaderValue> First()This member is not implemented in C#This member is not implemented in VB.Net
Returns

An object that can be used to enumerate the HttpCookiePairHeaderValue items in the collection. The iterator points to the first HttpCookiePairHeaderValue item in the HttpCookiePairHeaderValueCollection.

Attributes

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

Returns the HttpCookiePairHeaderValue at the specified index in the collection.

public HttpCookiePairHeaderValue GetAt(UInt32 index)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
System.UInt32 System.UInt32 System.UInt32

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

Returns
Attributes

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)
Returns
System.Collections.Generic.IEnumerator<T> System.Collections.Generic.IEnumerator<T> System.Collections.Generic.IEnumerator<T>

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

Attributes
See Also
System.Collections.Generic.IEnumerator<T>System.Collections.Generic.IEnumerator<T>System.Collections.Generic.IEnumerator<T>

GetMany(UInt32, HttpCookiePairHeaderValue[]) GetMany(UInt32, HttpCookiePairHeaderValue[]) GetMany(UInt32, HttpCookiePairHeaderValue[])

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

public unsigned short GetMany(UInt32 startIndex, HttpCookiePairHeaderValue[] items)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
startIndex
System.UInt32 System.UInt32 System.UInt32

The zero-based index of the start of the HttpCookiePairHeaderValue items in the HttpCookiePairHeaderValueCollection.

items
Windows.Web.Http.Headers.HttpCookiePairHeaderValue[] Windows.Web.Http.Headers.HttpCookiePairHeaderValue[] Windows.Web.Http.Headers.HttpCookiePairHeaderValue[]

An array of HttpCookiePairHeaderValue items that start at startIndex in the HttpCookiePairHeaderValueCollection.

Returns
uint uint uint

The number of HttpCookiePairHeaderValue items retrieved.

Attributes

GetView() GetView() GetView()

Returns an immutable view of the HttpCookiePairHeaderValueCollection.

public IVectorView<HttpCookiePairHeaderValue> GetView()This member is not implemented in C#This member is not implemented in VB.Net
Returns
Attributes

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
Parameters
item
T T T

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

Returns
System.Int32 System.Int32 System.Int32

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

Attributes

IndexOf(HttpCookiePairHeaderValue, UInt32) IndexOf(HttpCookiePairHeaderValue, UInt32) IndexOf(HttpCookiePairHeaderValue, UInt32)

Retrieves the index of an HttpCookiePairHeaderValue in the collection.

public PlatForm::Boolean IndexOf(HttpCookiePairHeaderValue value, UInt32 index)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
System.UInt32 System.UInt32 System.UInt32

The index of the HttpCookiePairHeaderValue in the HttpCookiePairHeaderValueCollection.

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

Returns
bool bool bool

Indicates whether the item is found.

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

Attributes

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)
Parameters
index
System.Int32 System.Int32 System.Int32

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

item
T T T

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

Attributes
Exceptions
System.ArgumentOutOfRangeException System.ArgumentOutOfRangeException System.ArgumentOutOfRangeException

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

System.NotSupportedException System.NotSupportedException System.NotSupportedException

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

See Also
System.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnly

InsertAt(UInt32, HttpCookiePairHeaderValue) InsertAt(UInt32, HttpCookiePairHeaderValue) InsertAt(UInt32, HttpCookiePairHeaderValue)

Inserts an HttpCookiePairHeaderValue into the collection at the specified index.

public void InsertAt(UInt32 index, HttpCookiePairHeaderValue value)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
System.UInt32 System.UInt32 System.UInt32

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

value
HttpCookiePairHeaderValue HttpCookiePairHeaderValue HttpCookiePairHeaderValue

The object to insert into the collection.

Attributes

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

Parses and adds an entry to the HttpCookiePairHeaderValueCollection.

public void ParseAdd(String input)public void ParseAdd(String input)Public Function ParseAdd(input As String) As void
Parameters
input
System.String System.String System.String

The entry to add.

Attributes

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)
Parameters
index
System.Int32 System.Int32 System.Int32

The zero-based index of the item to remove.

Attributes
Exceptions
System.ArgumentOutOfRangeException System.ArgumentOutOfRangeException System.ArgumentOutOfRangeException

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

System.NotSupportedException System.NotSupportedException System.NotSupportedException

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

See Also
System.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnlySystem.Collections.Generic.ICollection<T>.IsReadOnly

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

Removes the entry at the specified index from the HttpCookiePairHeaderValueCollection.

public void RemoveAt(UInt32 index)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
System.UInt32 System.UInt32 System.UInt32

The index of the entry to remove.

Attributes

RemoveAtEnd() RemoveAtEnd() RemoveAtEnd()

Removes the last HttpCookiePairHeaderValue item from the collection.

public void RemoveAtEnd()This member is not implemented in C#This member is not implemented in VB.Net
Attributes

ReplaceAll(HttpCookiePairHeaderValue[]) ReplaceAll(HttpCookiePairHeaderValue[]) ReplaceAll(HttpCookiePairHeaderValue[])

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

public void ReplaceAll(HttpCookiePairHeaderValue[] items)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
items
Windows.Web.Http.Headers.HttpCookiePairHeaderValue[] Windows.Web.Http.Headers.HttpCookiePairHeaderValue[] Windows.Web.Http.Headers.HttpCookiePairHeaderValue[]

The HttpCookiePairHeaderValue items to add to the collection.

Attributes

SetAt(UInt32, HttpCookiePairHeaderValue) SetAt(UInt32, HttpCookiePairHeaderValue) SetAt(UInt32, HttpCookiePairHeaderValue)

Sets the HttpCookiePairHeaderValue at the specified index in the collection.

public void SetAt(UInt32 index, HttpCookiePairHeaderValue value)This member is not implemented in C#This member is not implemented in VB.Net
Parameters
index
System.UInt32 System.UInt32 System.UInt32

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

Attributes

ToString() ToString() ToString()

Returns a string that represents the current HttpCookiePairHeaderValueCollection object.

public PlatForm::String ToString()public string ToString()Public Function ToString() As string
Returns
string string string

A string that represents the current object.

Attributes

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

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

public PlatForm::Boolean TryParseAdd(String input)public bool TryParseAdd(String input)Public Function TryParseAdd(input As String) As bool
Parameters
input
System.String System.String System.String

The item to parse and add.

Returns
bool bool bool

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

Attributes