HttpProductInfoHeaderValueCollection HttpProductInfoHeaderValueCollection HttpProductInfoHeaderValueCollection HttpProductInfoHeaderValueCollection Class

Represents the value of the User-Agent HTTP header on an HTTP request.

Syntax

Declaration

public sealed class HttpProductInfoHeaderValueCollectionpublic sealed class HttpProductInfoHeaderValueCollectionPublic NotInheritable Class HttpProductInfoHeaderValueCollectionpublic sealed class HttpProductInfoHeaderValueCollection

Remarks

The HttpProductInfoHeaderValueCollection represents the value of the User-Agent HTTP header on an HTTP request.

The HttpProductInfoHeaderValueCollection is a collection of HttpProductInfoHeaderValue objects used for product information in the HTTP User-Agent header.

The User-Agent header contains information about the user agent originating the request. The User-Agent header can contain multiple product tokens and comments identifying the user agent and any sub-products.

The UserAgent property on the HttpRequestHeaderCollection returns an HttpProductInfoHeaderValueCollection object.

Examples

The following sample code shows a method to get and set the User-Agent HTTP header on an HttpRequestMessage object using the properties and methods on the HttpProductInfoHeaderValueCollection and HttpProductInfoHeaderValue classes.


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

        public void DemonstrateHeaderRequestUserAgent() {
            var request = new HttpRequestMessage();
            bool parsedOk = false;

            // Set the header with a string.
            parsedOk = request.Headers.UserAgent.TryParseAdd("testprogram/1.0");

            // Set the header with a strong type.
            request.Headers.UserAgent.Add(new HttpProductInfoHeaderValue("myprogram", "2.2"));

            // Get the strong type out 
            foreach (var value in request.Headers.UserAgent) {
                System.Diagnostics.Debug.WriteLine("One of the UserAgent values: {0} / {1}", value.Product.Name, value.Product.Version);
            }

            // The ToString() is useful for diagnostics, too.
            System.Diagnostics.Debug.WriteLine("The UserAgent ToString() results: {0}", request.Headers.UserAgent.ToString());
        }

Properties summary

Gets the number of HttpProductInfoHeaderValue objects in the collection.

Methods summary

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

Removes all objects from the collection.

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

Returns the HttpProductInfoHeaderValue at the specified index in the collection.

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

Returns an immutable view of the HttpProductInfoHeaderValueCollection.

Retrieves the index of an HttpProductInfoHeaderValue in the collection.

Inserts an HttpProductInfoHeaderValue into the collection at the specified index.

Parses and adds an entry to the HttpProductInfoHeaderValueCollection.

Removes the entry at the specified index from the HttpMethodHeaderValueCollection.

Removes the last HttpProductInfoHeaderValue item from the collection.

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

Sets the HttpProductInfoHeaderValue at the specified index in the collection.

Returns a string that represents the current HttpProductInfoHeaderValueCollection object.

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

Properties

Methods

  • Append(HttpProductInfoHeaderValue)
    Append(HttpProductInfoHeaderValue)
    Append(HttpProductInfoHeaderValue)
    Append(HttpProductInfoHeaderValue)

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

    public void Append(HttpProductInfoHeaderValue value)public void Append(HttpProductInfoHeaderValue value)Public Function Append(value As HttpProductInfoHeaderValue) As voidpublic void Append(HttpProductInfoHeaderValue value)

    Parameters

  • Clear()
    Clear()
    Clear()
    Clear()

    Removes all objects from the collection.

    public void Clear()public void Clear()Public Function Clear() As voidpublic void Clear()
  • First()
    First()
    First()
    First()

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

    public IIterator<HttpProductInfoHeaderValue> First()public IIterator<HttpProductInfoHeaderValue> First()Public Function First() As IIterator( Of HttpProductInfoHeaderValue )public IIterator<HttpProductInfoHeaderValue> First()

    Returns

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

    Returns the HttpProductInfoHeaderValue at the specified index in the collection.

    public HttpProductInfoHeaderValue GetAt(UInt32 index)public HttpProductInfoHeaderValue GetAt(UInt32 index)Public Function GetAt(index As UInt32) As HttpProductInfoHeaderValuepublic HttpProductInfoHeaderValue GetAt(UInt32 index)

    Parameters

    • index
      System.UInt32
      System.UInt32
      System.UInt32
      System.UInt32

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

    Returns

  • GetMany(UInt32, HttpProductInfoHeaderValue[])
    GetMany(UInt32, HttpProductInfoHeaderValue[])
    GetMany(UInt32, HttpProductInfoHeaderValue[])
    GetMany(UInt32, HttpProductInfoHeaderValue[])

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

    public uint GetMany(UInt32 startIndex, HttpProductInfoHeaderValue[] items)public uint GetMany(UInt32 startIndex, HttpProductInfoHeaderValue[] items)Public Function GetMany(startIndex As UInt32, items As HttpProductInfoHeaderValue[]) As uintpublic uint GetMany(UInt32 startIndex, HttpProductInfoHeaderValue[] items)

    Parameters

    Returns

    • uint
      uint
      uint
      uint

      The number of items retrieved.

  • GetView()
    GetView()
    GetView()
    GetView()

    Returns an immutable view of the HttpProductInfoHeaderValueCollection.

    public IVectorView<HttpProductInfoHeaderValue> GetView()public IVectorView<HttpProductInfoHeaderValue> GetView()Public Function GetView() As IVectorView( Of HttpProductInfoHeaderValue )public IVectorView<HttpProductInfoHeaderValue> GetView()

    Returns

  • IndexOf(HttpProductInfoHeaderValue, UInt32)
    IndexOf(HttpProductInfoHeaderValue, UInt32)
    IndexOf(HttpProductInfoHeaderValue, UInt32)
    IndexOf(HttpProductInfoHeaderValue, UInt32)

    Retrieves the index of an HttpProductInfoHeaderValue in the collection.

    public bool IndexOf(HttpProductInfoHeaderValue value, UInt32 index)public bool IndexOf(HttpProductInfoHeaderValue value, UInt32 index)Public Function IndexOf(value As HttpProductInfoHeaderValue, index As UInt32) As boolpublic bool IndexOf(HttpProductInfoHeaderValue value, UInt32 index)

    Parameters

    Returns

    • bool
      bool
      bool
      bool

      Indicates whether the item is found.

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

  • InsertAt(UInt32, HttpProductInfoHeaderValue)
    InsertAt(UInt32, HttpProductInfoHeaderValue)
    InsertAt(UInt32, HttpProductInfoHeaderValue)
    InsertAt(UInt32, HttpProductInfoHeaderValue)

    Inserts an HttpProductInfoHeaderValue into the collection at the specified index.

    public void InsertAt(UInt32 index, HttpProductInfoHeaderValue value)public void InsertAt(UInt32 index, HttpProductInfoHeaderValue value)Public Function InsertAt(index As UInt32, value As HttpProductInfoHeaderValue) As voidpublic void InsertAt(UInt32 index, HttpProductInfoHeaderValue value)

    Parameters

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

    Parses and adds an entry to the HttpProductInfoHeaderValueCollection.

    public void ParseAdd(String input)public void ParseAdd(String input)Public Function ParseAdd(input As String) As voidpublic void ParseAdd(String input)

    Parameters

    • input
      System.String
      System.String
      System.String
      System.String

      The entry to add.

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

    Removes the entry at the specified index from the HttpMethodHeaderValueCollection.

    public void RemoveAt(UInt32 index)public void RemoveAt(UInt32 index)Public Function RemoveAt(index As UInt32) As voidpublic void RemoveAt(UInt32 index)

    Parameters

    • index
      System.UInt32
      System.UInt32
      System.UInt32
      System.UInt32

      The index of the entry to remove.

  • RemoveAtEnd()
    RemoveAtEnd()
    RemoveAtEnd()
    RemoveAtEnd()

    Removes the last HttpProductInfoHeaderValue item from the collection.

    public void RemoveAtEnd()public void RemoveAtEnd()Public Function RemoveAtEnd() As voidpublic void RemoveAtEnd()
  • ReplaceAll(HttpProductInfoHeaderValue[])
    ReplaceAll(HttpProductInfoHeaderValue[])
    ReplaceAll(HttpProductInfoHeaderValue[])
    ReplaceAll(HttpProductInfoHeaderValue[])

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

    public void ReplaceAll(HttpProductInfoHeaderValue[] items)public void ReplaceAll(HttpProductInfoHeaderValue[] items)Public Function ReplaceAll(items As HttpProductInfoHeaderValue[]) As voidpublic void ReplaceAll(HttpProductInfoHeaderValue[] items)

    Parameters

    • items
      Windows.Web.Http.Headers.HttpProductInfoHeaderValue[]
      Windows.Web.Http.Headers.HttpProductInfoHeaderValue[]
      Windows.Web.Http.Headers.HttpProductInfoHeaderValue[]
      Windows.Web.Http.Headers.HttpProductInfoHeaderValue[]

      The HttpProductInfoHeaderValue items to add to the collection.

  • SetAt(UInt32, HttpProductInfoHeaderValue)
    SetAt(UInt32, HttpProductInfoHeaderValue)
    SetAt(UInt32, HttpProductInfoHeaderValue)
    SetAt(UInt32, HttpProductInfoHeaderValue)

    Sets the HttpProductInfoHeaderValue at the specified index in the collection.

    public void SetAt(UInt32 index, HttpProductInfoHeaderValue value)public void SetAt(UInt32 index, HttpProductInfoHeaderValue value)Public Function SetAt(index As UInt32, value As HttpProductInfoHeaderValue) As voidpublic void SetAt(UInt32 index, HttpProductInfoHeaderValue value)

    Parameters

  • ToString()
    ToString()
    ToString()
    ToString()

    Returns a string that represents the current HttpProductInfoHeaderValueCollection object.

    public string ToString()public string ToString()Public Function ToString() As stringpublic string ToString()

    Returns

    • 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 HttpProductInfoHeaderValueCollection.

    public bool TryParseAdd(String input)public bool TryParseAdd(String input)Public Function TryParseAdd(input As String) As boolpublic bool TryParseAdd(String input)

    Parameters

    • input
      System.String
      System.String
      System.String
      System.String

      The item to parse and add.

    Returns

    • bool
      bool
      bool
      bool

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

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.DualApiPartitionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.ThreadingAttribute

Details

Assembly

Windows.Web.Http.Headers.dll