SortEntryVector SortEntryVector SortEntryVector SortEntryVector Class

Definition

Namespace:: Windows.Storage.Search Windows.Storage.Search Windows.Storage.Search Windows.Storage.Search

Edit

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

public : sealed class SortEntryVector : IIterable, IVectorpublic sealed class SortEntryVector : IEnumerable, IListPublic NotInheritable Class SortEntryVector Implements IEnumerable, IList// You can use this class in JavaScript.

Attributes: ContractVersionAttribute

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]

Edit

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

Edit

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// You can use this property in JavaScript.

Value: unsigned int uint uint uint

The number of sort entries.

Methods

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

Edit

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// You can use this method in JavaScript.

Parameters

value: SortEntry SortEntry SortEntry SortEntry

The sort entry to append to the collection.

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

Edit

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// You can use this method in JavaScript.

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

Edit

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// You can use this method in JavaScript.

Returns

IIterator<SortEntry> IIterator<SortEntry> IIterator<SortEntry> IIterator<SortEntry>

The iterator.

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

Edit

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// You can use this method in JavaScript.

Parameters

index: unsigned int UInt32 UInt32 UInt32

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

Returns

SortEntry SortEntry SortEntry SortEntry

The sort entry at the specified index.

GetEnumerator() GetEnumerator() GetEnumerator() GetEnumerator()

Edit

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[])

Edit

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// You can use this method in JavaScript.

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

Edit

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// You can use this method in JavaScript.

Returns

IVectorView<SortEntry> IReadOnlyList<SortEntry> IReadOnlyList<SortEntry> IReadOnlyList<SortEntry>

The view of the collection.

IndexOf(T) IndexOf(T) IndexOf(T) IndexOf(T)

Edit

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

Edit

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// You can use this method in JavaScript.

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)

Edit

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)

Edit

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// You can use this method in JavaScript.

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)

Edit

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)

Edit

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// You can use this method in JavaScript.

Parameters

index: unsigned int UInt32 UInt32 UInt32

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

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

Edit

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// You can use this method in JavaScript.

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

Edit

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// You can use this method in JavaScript.

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)

Edit

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// You can use this method in JavaScript.

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.