HttpLanguageHeaderValueCollection HttpLanguageHeaderValueCollection HttpLanguageHeaderValueCollection HttpLanguageHeaderValueCollection HttpLanguageHeaderValueCollection Class

Definition

Represents the value of the Content-Language HTTP header on HTTP content in a request or a response.

public : sealed class HttpLanguageHeaderValueCollection : IIterable<Language>, IVector<Language>, IStringable, IHttpLanguageHeaderValueCollection
struct winrt::Windows::Web::Http::Headers::HttpLanguageHeaderValueCollection : IIterable<Language>, IVector<Language>, IStringable, IHttpLanguageHeaderValueCollection
public sealed class HttpLanguageHeaderValueCollection : IEnumerable<Language>, IList<Language>, IStringable, IHttpLanguageHeaderValueCollection
Public NotInheritable Class HttpLanguageHeaderValueCollection Implements IEnumerable<Language>, IList<Language>, IStringable, IHttpLanguageHeaderValueCollection
// 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 HttpLanguageHeaderValueCollection class represents the value of the Content-Language HTTP header on HTTP content sent in an HTTP request or received in an response.

The ContentLanguage property on the HttpContentHeaderCollection returns an HttpLanguageHeaderValueCollection 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 Language 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 = httpLanguageHeaderValueCollection.size;
Value
uint uint uint

the number of Language objects in the HttpLanguageHeaderValueCollection.

Methods

Append(Language) Append(Language) Append(Language) Append(Language) Append(Language)

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

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

The new item to add.

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
httpLanguageHeaderValueCollection.clear();

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

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

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

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

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

Returns the Language item at the specified index in the collection.

public : Language GetAt(unsigned int index)
Language GetAt(uint32_t index) const;
// This member is not implemented in C#
' This member is not implemented in VB.Net
var language = httpLanguageHeaderValueCollection.getAt(index);
Parameters
index
UInt32 UInt32 UInt32

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

Returns

The Language item at the specified index in the HttpLanguageHeaderValueCollection.

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

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

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

The zero-based index of the start of the Language items in the HttpLanguageHeaderValueCollection.

items
Language[] Language[] Language[]

An array of Language items that start at startIndex in the HttpLanguageHeaderValueCollection.

Returns
uint uint uint

The number of items retrieved.

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

Returns an immutable view of the HttpLanguageHeaderValueCollection.

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

The view of the HttpLanguageHeaderValueCollection.

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

Retrieves the index of a Language in the collection.

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

The index of the Language item in the HttpLanguageHeaderValueCollection.

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 Language 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, Language) InsertAt(UInt32, Language) InsertAt(UInt32, Language) InsertAt(UInt32, Language) InsertAt(UInt32, Language)

Inserts a Language into the collection at the specified index.

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

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

value
Language Language Language

The object to insert into the collection.

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

Parses and adds an entry to the HttpLanguageHeaderValueCollection.

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
httpLanguageHeaderValueCollection.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 Content-Language 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 HttpLanguageHeaderValueCollection.

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
httpLanguageHeaderValueCollection.removeAt(index);
Parameters
index
UInt32 UInt32 UInt32

The index of the entry to remove.

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

Removes the last Language 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
httpLanguageHeaderValueCollection.removeAtEnd();

ReplaceAll(Language[]) ReplaceAll(Language[]) ReplaceAll(Language[]) ReplaceAll(Language[]) ReplaceAll(Language[])

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

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

The Language items to add to the collection.

SetAt(UInt32, Language) SetAt(UInt32, Language) SetAt(UInt32, Language) SetAt(UInt32, Language) SetAt(UInt32, Language)

Sets the Language at the specified index in the collection.

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

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

value
Language Language Language

The item to set.

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

Returns a string that represents the current HttpLanguageHeaderValueCollection object.

public : Platform::String ToString()
winrt::hstring ToString() const;
public string ToString()
Public Function ToString() As string
var string = httpLanguageHeaderValueCollection.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 HttpLanguageHeaderValueCollection.

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 = httpLanguageHeaderValueCollection.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.