HttpCookiePairHeaderValueCollection HttpCookiePairHeaderValueCollection HttpCookiePairHeaderValueCollection HttpCookiePairHeaderValueCollection 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// You can use this class in JavaScript.
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 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);
            }

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

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 TT 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 HttpCookiePairHeaderValue objects in the collection.

public : unsigned int Size { get; }This member is not implemented in C#This member is not implemented in VB.Net// You can use this property in JavaScript.
Value
unsigned int uint uint uint

The number of HttpCookiePairHeaderValue objects in the HttpCookiePairHeaderValueCollection.

Methods

Append(HttpCookiePairHeaderValue) 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// You can use this method in JavaScript.
Parameters

Clear() 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// You can use this method in JavaScript.

First() 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// You can use this method in JavaScript.
Returns

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

Returns the HttpCookiePairHeaderValue at the specified index in the collection.

public : HttpCookiePairHeaderValue GetAt(unsigned int index)This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
Parameters
index
unsigned int UInt32 UInt32 UInt32

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

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, HttpCookiePairHeaderValue[]) GetMany(UInt32, HttpCookiePairHeaderValue[]) GetMany(UInt32, HttpCookiePairHeaderValue[]) GetMany(UInt32, HttpCookiePairHeaderValue[])

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

public : unsigned int GetMany(unsigned int startIndex, HttpCookiePairHeaderValue[] items)This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
Parameters
startIndex
unsigned int UInt32 UInt32 UInt32

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

items
HttpCookiePairHeaderValue[] HttpCookiePairHeaderValue[] HttpCookiePairHeaderValue[] HttpCookiePairHeaderValue[]

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

Returns
unsigned int uint uint uint

The number of HttpCookiePairHeaderValue items retrieved.

GetView() 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// You can use this method in JavaScript.
Returns
IVectorView<HttpCookiePairHeaderValue> IReadOnlyList<HttpCookiePairHeaderValue> IReadOnlyList<HttpCookiePairHeaderValue> IReadOnlyList<HttpCookiePairHeaderValue>

The view of the HttpCookiePairHeaderValueCollection.

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 Integerint 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(HttpCookiePairHeaderValue, UInt32) IndexOf(HttpCookiePairHeaderValue, UInt32) IndexOf(HttpCookiePairHeaderValue, UInt32) IndexOf(HttpCookiePairHeaderValue, UInt32)

Retrieves the index of an HttpCookiePairHeaderValue in the collection.

public : PlatForm::Boolean IndexOf(HttpCookiePairHeaderValue value, unsigned int index)This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
Parameters
index
unsigned int UInt32 UInt32 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
PlatForm::Boolean bool bool bool

Indicates whether the item is found.

true if the HttpCookiePairHeaderValue 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, HttpCookiePairHeaderValue) InsertAt(UInt32, HttpCookiePairHeaderValue) InsertAt(UInt32, HttpCookiePairHeaderValue) InsertAt(UInt32, HttpCookiePairHeaderValue)

Inserts an HttpCookiePairHeaderValue into the collection at the specified index.

public : void InsertAt(unsigned int index, HttpCookiePairHeaderValue value)This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
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 HttpCookiePairHeaderValueCollection.

public : void ParseAdd(PlatForm::String input)public void ParseAdd(String input)Public Function ParseAdd(input As String) As void// You can use this method in JavaScript.
Parameters
input
PlatForm::String String String String

The entry to add.

Remarks

Below are the 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 Cookie 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 HttpCookiePairHeaderValueCollection.

public : void RemoveAt(unsigned int index)This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
Parameters
index
unsigned int UInt32 UInt32 UInt32

The index of the entry to remove.

RemoveAtEnd() 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// You can use this method in JavaScript.

ReplaceAll(HttpCookiePairHeaderValue[]) 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// You can use this method in JavaScript.
Parameters
items
HttpCookiePairHeaderValue[] HttpCookiePairHeaderValue[] HttpCookiePairHeaderValue[] HttpCookiePairHeaderValue[]

The HttpCookiePairHeaderValue items to add to the collection.

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

Sets the HttpCookiePairHeaderValue at the specified index in the collection.

public : void SetAt(unsigned int index, HttpCookiePairHeaderValue value)This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.
Parameters
index
unsigned int UInt32 UInt32 UInt32

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

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

Returns a string that represents the current HttpCookiePairHeaderValueCollection object.

public : PlatForm::String ToString()public string ToString()Public Function ToString() As string// You can use this method in JavaScript.
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 HttpCookiePairHeaderValueCollection.

public : PlatForm::Boolean TryParseAdd(PlatForm::String input)public bool TryParseAdd(String input)Public Function TryParseAdd(input As String) As bool// You can use this method in JavaScript.
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.