Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

HttpCookiePairHeaderValueCollection class

Applies to Windows and Windows Phone

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

Syntax


public ref class HttpCookiePairHeaderValueCollection sealed : IVector<HttpCookiePairHeaderValue>,
    IIterable<HttpCookiePairHeaderValue>,
    IStringable

Attributes

[DualApiPartition()]
[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06030000)]

Members

The HttpCookiePairHeaderValueCollection class has these types of members:

Methods

The HttpCookiePairHeaderValueCollection class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
Add [C#, VB]Adds a new item to the end of the collection.
Append [C++, JavaScript]Adds a new HttpCookiePairHeaderValue item to the end of the collection.
Clear Removes all objects from the collection.
Contains [C#, VB]Determines whether an element is in the collection.
CopyTo [C#, VB]Copies the elements of the collection to an array, starting at a particular array index in the destination array.
First [C++, JavaScript]Retrieves an iterator to the first HttpCookiePairHeaderValue item in the collection.
GetAt [C++, JavaScript]Returns the HttpCookiePairHeaderValue at the specified index in the collection.
GetMany [C++, JavaScript]Retrieves the HttpCookiePairHeaderValue items that start at the specified index in the collection.
GetView [C++, JavaScript]Returns an immutable view of the HttpCookiePairHeaderValueCollection.
IndexOf [C++, JavaScript]Retrieves the index of an HttpCookiePairHeaderValue in the collection.
IndexOf [C#, VB]Determines the index of a specific item in the collection.
Insert [C#, VB]Inserts an item into the collection at the specified index.
InsertAt [C++, JavaScript]Inserts an HttpCookiePairHeaderValue into the collection at the specified index.
ParseAdd Parses and adds an entry to the HttpCookiePairHeaderValueCollection.
Remove [C#, VB]Removes a specific object from the collection.
RemoveAt [C++, JavaScript]Removes the entry at the specified index from the HttpCookiePairHeaderValueCollection.
RemoveAt [C#, VB]Removes the element at the specified index of the collection.
RemoveAtEnd [C++, JavaScript]Removes the last HttpCookiePairHeaderValue item from the collection.
ReplaceAll [C++, JavaScript]Replaces all the HttpCookiePairHeaderValue items in the collection with the specified HttpCookiePairHeaderValue items.
SetAt [C++, JavaScript]Sets the HttpCookiePairHeaderValue at the specified index in the collection.
ToString Returns a string that represents the current HttpCookiePairHeaderValueCollection object.
TryParseAdd Tries to parse and add the specified item to the HttpCookiePairHeaderValueCollection.

 

Properties

The HttpCookiePairHeaderValueCollection class has these properties.

PropertyAccess typeDescription

Count [C#, VB]

Read-onlyGets the number of elements that are contained in the collection.

IsReadOnly [C#, VB]

Read-onlyGets a value indicating whether the collection is read-only.

Item [C#, VB]

Read/writeGets or sets the element at the specified index.

Size [C++, JavaScript]

Read-onlyGets the number of HttpCookiePairHeaderValue objects in the collection.

 

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


Requirements

Minimum supported client

Windows 8.1 [Windows Store apps, desktop apps]

Minimum supported server

Windows Server 2012 R2 [Windows Store apps, desktop apps]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.Web.Http.Headers
Windows::Web::Http::Headers [C++]

Metadata

Windows.winmd

See also

Object
IVector(HttpCookiePairHeaderValue)
IIterable(HttpCookiePairHeaderValue)
IStringable

 

 

Show:
© 2014 Microsoft