HttpTransferCodingHeaderValueCollection HttpTransferCodingHeaderValueCollection HttpTransferCodingHeaderValueCollection HttpTransferCodingHeaderValueCollection HttpTransferCodingHeaderValueCollection Class

Definition

Represents the value of the Transfer-Encoding HTTP header on an HTTP request.

public : sealed class HttpTransferCodingHeaderValueCollection : IIterable<HttpTransferCodingHeaderValue>, IVector<HttpTransferCodingHeaderValue>, IStringable, IHttpTransferCodingHeaderValueCollection
struct winrt::Windows::Web::Http::Headers::HttpTransferCodingHeaderValueCollection : IIterable<HttpTransferCodingHeaderValue>, IVector<HttpTransferCodingHeaderValue>, IStringable, IHttpTransferCodingHeaderValueCollection
public sealed class HttpTransferCodingHeaderValueCollection : IEnumerable<HttpTransferCodingHeaderValue>, IList<HttpTransferCodingHeaderValue>, IStringable, IHttpTransferCodingHeaderValueCollection
Public NotInheritable Class HttpTransferCodingHeaderValueCollection Implements IEnumerable<HttpTransferCodingHeaderValue>, IList<HttpTransferCodingHeaderValue>, IStringable, IHttpTransferCodingHeaderValueCollection
// 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)

Remarks

The HttpTransferCodingHeaderValueCollection represents the value of the Transfer-Encoding HTTP header on an HTTP request.

The HttpTransferCodingHeaderValueCollection is a collection of HttpTransferCodingHeaderValue objects used for transfer coding information in the HTTP Transfer-Encoding header.

The TransferEncoding property on the HttpRequestHeaderCollection returns an HttpTransferCodingHeaderValueCollection 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++/CX
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 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 Size

Gets the number of HttpTransferCodingHeaderValue objects in the collection.

public : unsigned int Size { get; }
uint32_t Size();
// This member is not implemented in C#
' This member is not implemented in VB.Net
var uint = httpTransferCodingHeaderValueCollection.size;
Value
uint uint uint

The number of HttpTransferCodingHeaderValue objects in the HttpTransferCodingHeaderValueCollection.

Methods

Append(HttpTransferCodingHeaderValue) Append(HttpTransferCodingHeaderValue) Append(HttpTransferCodingHeaderValue) Append(HttpTransferCodingHeaderValue) Append(HttpTransferCodingHeaderValue)

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

public : void Append(HttpTransferCodingHeaderValue value)
void Append(HttpTransferCodingHeaderValue value) const;
// This member is not implemented in C#
' This member is not implemented in VB.Net
httpTransferCodingHeaderValueCollection.append(value);
Parameters

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

Removes all objects from the collection.

public : void Clear()
void Clear() const;
// This member is not implemented in C#
' This member is not implemented in VB.Net
httpTransferCodingHeaderValueCollection.clear();

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

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

public : IIterator<HttpTransferCodingHeaderValue> First()
IIterator<HttpTransferCodingHeaderValue> First() const;
// This member is not implemented in C#
' This member is not implemented in VB.Net
var iIterator = httpTransferCodingHeaderValueCollection.first();
Returns

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

Returns the HttpTransferCodingHeaderValue at the specified index in the collection.

public : HttpTransferCodingHeaderValue GetAt(unsigned int index)
HttpTransferCodingHeaderValue GetAt(uint32_t index) const;
// This member is not implemented in C#
' This member is not implemented in VB.Net
var httpTransferCodingHeaderValue = httpTransferCodingHeaderValueCollection.getAt(index);
Parameters
index
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++/CX
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, HttpTransferCodingHeaderValue[]) GetMany(UInt32, HttpTransferCodingHeaderValue[]) GetMany(UInt32, HttpTransferCodingHeaderValue[]) GetMany(UInt32, HttpTransferCodingHeaderValue[]) GetMany(UInt32, HttpTransferCodingHeaderValue[])

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

public : unsigned int GetMany(unsigned int startIndex, HttpTransferCodingHeaderValue[] items)
uint32_t GetMany(uint32_t startIndex, HttpTransferCodingHeaderValue[] items) const;
// This member is not implemented in C#
' This member is not implemented in VB.Net
var uint = httpTransferCodingHeaderValueCollection.getMany(startIndex, items);
Parameters
startIndex
UInt32 UInt32 UInt32

The zero-based index of the start of the HttpTransferCodingHeaderValue items in the HttpTransferCodingHeaderValueCollection.

items
HttpTransferCodingHeaderValue[] HttpTransferCodingHeaderValue[] HttpTransferCodingHeaderValue[]

An array of HttpTransferCodingHeaderValue items that start at startIndex in the HttpTransferCodingHeaderValueCollection.

Returns
uint uint uint

The number of items retrieved.

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

Returns an immutable view of the HttpTransferCodingHeaderValueCollection.

public : IVectorView<HttpTransferCodingHeaderValue> GetView()
IVectorView<HttpTransferCodingHeaderValue> GetView() const;
// This member is not implemented in C#
' This member is not implemented in VB.Net
var iVectorView = httpTransferCodingHeaderValueCollection.getView();
Returns
IReadOnlyList<HttpTransferCodingHeaderValue> IReadOnlyList<HttpTransferCodingHeaderValue> IReadOnlyList<HttpTransferCodingHeaderValue>

The view of the HttpTransferCodingHeaderValueCollection.

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++/CX
int IndexOf(T item)
Function IndexOf(item As T) As Integer
int IndexOf(T item)
Parameters
item
T 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(HttpTransferCodingHeaderValue, UInt32) IndexOf(HttpTransferCodingHeaderValue, UInt32) IndexOf(HttpTransferCodingHeaderValue, UInt32) IndexOf(HttpTransferCodingHeaderValue, UInt32) IndexOf(HttpTransferCodingHeaderValue, UInt32)

Retrieves the index of an HttpTransferCodingHeaderValue in the collection.

public : Platform::Boolean IndexOf(HttpTransferCodingHeaderValue value, unsigned int index)
bool IndexOf(HttpTransferCodingHeaderValue value, uint32_t index) const;
// This member is not implemented in C#
' This member is not implemented in VB.Net
var bool = httpTransferCodingHeaderValueCollection.indexOf(value, index);
Parameters
index
UInt32 UInt32 UInt32

The index of the HttpTransferCodingHeaderValue in the HttpTransferCodingHeaderValueCollection.

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 HttpTransferCodingHeaderValue 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++/CX
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 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, HttpTransferCodingHeaderValue) InsertAt(UInt32, HttpTransferCodingHeaderValue) InsertAt(UInt32, HttpTransferCodingHeaderValue) InsertAt(UInt32, HttpTransferCodingHeaderValue) InsertAt(UInt32, HttpTransferCodingHeaderValue)

Inserts an HttpTransferCodingHeaderValue into the collection at the specified index.

public : void InsertAt(unsigned int index, HttpTransferCodingHeaderValue value)
void InsertAt(uint32_t index, HttpTransferCodingHeaderValue value) const;
// This member is not implemented in C#
' This member is not implemented in VB.Net
httpTransferCodingHeaderValueCollection.insertAt(index, value);
Parameters
index
UInt32 UInt32 UInt32

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

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

Parses and adds an entry to the HttpTransferCodingHeaderValueCollection.

public : void ParseAdd(Platform::String input)
void ParseAdd(winrt::hstring input) const;
public void ParseAdd(String input)
Public Function ParseAdd(input As String) As void
httpTransferCodingHeaderValueCollection.parseAdd(input);
Parameters
input
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 Transfer-Encoding 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++/CX
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) RemoveAt(UInt32)

Removes the entry at the specified index from the HttpTransferCodingHeaderValueCollection.

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

The index of the entry to remove.

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

Removes the last HttpTransferCodingHeaderValue item from the collection.

public : void RemoveAtEnd()
void RemoveAtEnd() const;
// This member is not implemented in C#
' This member is not implemented in VB.Net
httpTransferCodingHeaderValueCollection.removeAtEnd();

ReplaceAll(HttpTransferCodingHeaderValue[]) ReplaceAll(HttpTransferCodingHeaderValue[]) ReplaceAll(HttpTransferCodingHeaderValue[]) ReplaceAll(HttpTransferCodingHeaderValue[]) ReplaceAll(HttpTransferCodingHeaderValue[])

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

public : void ReplaceAll(HttpTransferCodingHeaderValue[] items)
void ReplaceAll(HttpTransferCodingHeaderValue[] items) const;
// This member is not implemented in C#
' This member is not implemented in VB.Net
httpTransferCodingHeaderValueCollection.replaceAll(items);
Parameters
items
HttpTransferCodingHeaderValue[] HttpTransferCodingHeaderValue[] HttpTransferCodingHeaderValue[]

The HttpTransferCodingHeaderValue items to add to the collection.

SetAt(UInt32, HttpTransferCodingHeaderValue) SetAt(UInt32, HttpTransferCodingHeaderValue) SetAt(UInt32, HttpTransferCodingHeaderValue) SetAt(UInt32, HttpTransferCodingHeaderValue) SetAt(UInt32, HttpTransferCodingHeaderValue)

Sets the HttpTransferCodingHeaderValue at the specified index in the collection.

public : void SetAt(unsigned int index, HttpTransferCodingHeaderValue value)
void SetAt(uint32_t index, HttpTransferCodingHeaderValue value) const;
// This member is not implemented in C#
' This member is not implemented in VB.Net
httpTransferCodingHeaderValueCollection.setAt(index, value);
Parameters
index
UInt32 UInt32 UInt32

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

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

Returns a string that represents the current HttpTransferCodingHeaderValueCollection object.

public : Platform::String ToString()
winrt::hstring ToString() const;
public string ToString()
Public Function ToString() As string
var string = httpTransferCodingHeaderValueCollection.toString();
Returns
string string string

A string that represents the current object.

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

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

public : Platform::Boolean TryParseAdd(Platform::String input)
bool TryParseAdd(winrt::hstring input) const;
public bool TryParseAdd(String input)
Public Function TryParseAdd(input As String) As bool
var bool = httpTransferCodingHeaderValueCollection.tryParseAdd(input);
Parameters
input
String String String

The item to parse and add.

Returns
bool bool bool

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

See Also