SortEntryVector SortEntryVector SortEntryVector SortEntryVector Class

Definition

Provides access to the sorting criteria of the query results as a collection of SortEntry objects.

public : sealed class SortEntryVector : IIterable<SortEntry>, IVector<SortEntry>
public sealed class SortEntryVector : IEnumerable<SortEntry>, IList<SortEntry>
Public NotInheritable Class SortEntryVector Implements IEnumerable<SortEntry>, IList<SortEntry>
// 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

Note

Although it's not attributed with marshalling_behavior(agile), this class can be treated as agile. For more info, see Threading and Marshaling (C++/CX).

You can retrieve this object using QueryOptions.SortOrder.

Collection member lists

For JavaScript, SortEntryVector has the members shown in the member lists. In addition, SortEntryVector supports a length property, members of Array.prototype, and using an index to access items.

Enumerating the collection in C# or Microsoft Visual Basic

A SortEntryVector is enumerable, so you can use language-specific syntax such as foreach in C# to enumerate the items in the collection. The compiler does the type-casting for you and you won't need to cast to IEnumerable<SortEntry> explicitly. If you do need to cast explicitly, for example if you want to call GetEnumerator, cast to IEnumerable<T> with a SortEntry constraint.

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 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

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 sort entries in the collection.

public : unsigned int Size { get; }
This member is not implemented in C#
This member is not implemented in VB.Net
var uint = sortEntryVector.size;
Value
unsigned int uint uint uint

The number of sort entries.

Methods

Append(SortEntry) Append(SortEntry) Append(SortEntry) Append(SortEntry)

Appends a sort entry to the end of the collection.

public : void Append(SortEntry value)
This member is not implemented in C#
This member is not implemented in VB.Net
sortEntryVector.append(value);
Parameters
value
SortEntry SortEntry SortEntry SortEntry

The sort entry to append to the collection.

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

Removes all sort entries from the collection.

public : void Clear()
This member is not implemented in C#
This member is not implemented in VB.Net
sortEntryVector.clear();

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

Retrieves an iterator that iterates through the sort entries in the collection.

public : IIterator<SortEntry> First()
This member is not implemented in C#
This member is not implemented in VB.Net
var iIterator = sortEntryVector.first();
Returns

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

Retrieves the sort entry at the specified index in the collection.

public : SortEntry GetAt(unsigned int index)
This member is not implemented in C#
This member is not implemented in VB.Net
var sortEntry = sortEntryVector.getAt(index);
Parameters
index
unsigned int UInt32 UInt32 UInt32

The zero-based index of the sort entry to retrieve.

Returns

The sort entry at the specified index.

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

Retrieves the sort entries that start at the specified index in the collection.

public : unsigned int GetMany(unsigned int startIndex, SortEntry[] items)
This member is not implemented in C#
This member is not implemented in VB.Net
var uint = sortEntryVector.getMany(startIndex, items);
Parameters
startIndex
unsigned int UInt32 UInt32 UInt32

The zero-based index of the start of the sort entries in the collection to retrieve.

items
SortEntry[] SortEntry[] SortEntry[] SortEntry[]

The sort entries in the collection that start at startIndex.

Returns
unsigned int uint uint uint

The number of items retrieved.

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

Retrieves an immutable view of the collection of sort entries.

public : IVectorView<SortEntry> GetView()
This member is not implemented in C#
This member is not implemented in VB.Net
var iVectorView = sortEntryVector.getView();
Returns
IVectorView<SortEntry> IReadOnlyList<SortEntry> IReadOnlyList<SortEntry> IReadOnlyList<SortEntry>

The view of the collection.

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 Integer
int 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(SortEntry, UInt32) IndexOf(SortEntry, UInt32) IndexOf(SortEntry, UInt32) IndexOf(SortEntry, UInt32)

Retrieves the index of a specified sort entry in the collection.

public : Platform::Boolean IndexOf(SortEntry value, unsigned int index)
This member is not implemented in C#
This member is not implemented in VB.Net
var bool = sortEntryVector.indexOf(value, index);
Parameters
value
SortEntry SortEntry SortEntry SortEntry

The sort entry to find in the collection.

index
unsigned int UInt32 UInt32 UInt32

The zero-based index of the sort entry, if found. This parameter is set to zero if the sort entry is not found.

Returns
Platform::Boolean bool bool bool

True if the sort entry 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, SortEntry) InsertAt(UInt32, SortEntry) InsertAt(UInt32, SortEntry) InsertAt(UInt32, SortEntry)

Inserts a sort entry into the collection at a specified index.

public : void InsertAt(unsigned int index, SortEntry value)
This member is not implemented in C#
This member is not implemented in VB.Net
sortEntryVector.insertAt(index, value);
Parameters
index
unsigned int UInt32 UInt32 UInt32

The zero-based index of the location to insert the sort entry.

value
SortEntry SortEntry SortEntry SortEntry

The sort entry to insert.

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 sort entry at the specified index in the collection.

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

The zero-based index of the sort entry to remove.

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

Removes the last sort entry from the collection.

public : void RemoveAtEnd()
This member is not implemented in C#
This member is not implemented in VB.Net
sortEntryVector.removeAtEnd();

ReplaceAll(SortEntry[]) ReplaceAll(SortEntry[]) ReplaceAll(SortEntry[]) ReplaceAll(SortEntry[])

Replaces all sort entries in the collection with the specified sort entries.

public : void ReplaceAll(SortEntry[] items)
This member is not implemented in C#
This member is not implemented in VB.Net
sortEntryVector.replaceAll(items);
Parameters
items
SortEntry[] SortEntry[] SortEntry[] SortEntry[]

The collection of sort entries to put in the vector.

SetAt(UInt32, SortEntry) SetAt(UInt32, SortEntry) SetAt(UInt32, SortEntry) SetAt(UInt32, SortEntry)

Sets the sort entry at the specified index of the collection.

public : void SetAt(unsigned int index, SortEntry value)
This member is not implemented in C#
This member is not implemented in VB.Net
sortEntryVector.setAt(index, value);
Parameters
index
unsigned int UInt32 UInt32 UInt32

The zero-based index of the location at which to set the sort entry.

value
SortEntry SortEntry SortEntry SortEntry

The sort entry.