IVector<T> Interface

Reference

Definition

Namespace:: Windows.Foundation.Collections

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Represents a random-access collection of elements.

.NET This interface appears to .NET code as System.Collections.Generic.IList<T> due to .NET language projection. In any case where a Windows Runtime type has implemented IVector<T>, .NET code can use the APIs of IList<T> instead.

public interface class IVector : IIterable<T>

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.FoundationContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(2436052969, 4513, 17221, 163, 162, 78, 127, 149, 110, 34, 45)]
template <typename T>
struct IVector : IIterable<T>

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.FoundationContract), 65536)]
[Windows.Foundation.Metadata.Guid(2436052969, 4513, 17221, 163, 162, 78, 127, 149, 110, 34, 45)]
public interface IList<T> : IEnumerable<T>

Public Interface IList(Of T)
Implements IEnumerable(Of T)

Type Parameters

T

Attributes: ContractVersionAttribute GuidAttribute

Implements: IIterable<T> IEnumerable<T>

Windows requirements

Device family	Windows 10 (introduced in 10.0.10240.0)
API contract	Windows.Foundation.FoundationContract (introduced in v1.0)

Remarks

When programming with .NET, this interface is hidden and developers should use the System.Collections.Generic.IList<T> interface if they want to implement a vector/list type. In any case where a Windows Runtime type has implemented IVector<T>, .NET code can use the APIs of IList<T> instead. This includes all the existing Windows Runtime API and also scenarios such as using the APIs of Windows Runtime components originally implemented in Visual C++ component extensions (C++/CX) from a C# or Visual Basic app.

The IVector<T> interface represents a collection of objects of a specified type that can be individually accessed by index. Properties and methods of IVector<T> support list-type functionality, such as getting the size of the collection, and adding and removing items at specified locations in the collection. Additionally, the GetView method provides a snapshot of the vector whose observable state does not change. The snapshot is useful when you need a view of the collection to refer to in subsequent operations that involve IVector<T>.

C++/WinRT extension functions

Note

Extension functions exist on the C++/WinRT projection types for certain Windows Runtime APIs. For example, winrt::Windows::Foundation::IAsyncAction is the C++/WinRT projection type for IAsyncAction. The extension functions aren't part of the application binary interface (ABI) surface of the actual Windows Runtime types, so they're not listed as members of the Windows Runtime APIs. But you can call them from within any C++/WinRT project. See C++/WinRT functions that extend Windows Runtime APIs.

auto begin() const;

Returns an iterator to the first element of the collection, for use in C++ algorithms such as range-based for loops.

auto end() const;

Returns an iterator to one past the last element of the collection, for use in C++ algorithms such as range-based for loops.

Interface inheritance

IVector inherits IIterable. Types that implement IVector also implement the interface members of IIterable. Similarly, if you're using .NET, there is support for IEnumerable<T>.

Properties

Size	Gets the number of items in the vector.

Methods

Append(T)	Appends an item to the end of the vector.
Clear()	Removes all items from the vector.
GetAt(UInt32)	Returns the item at the specified index in the vector.
GetMany(UInt32, T[])	Retrieves multiple items from the the vector beginning at the given index. C++/WinRT The correct syntax for the C++/WinRT language projection is `uint32_t GetMany(uint32_t startIndex, winrt::array_view<T> items);`.
GetView()	Returns an immutable view of the vector.
IndexOf(T, UInt32)	Retrieves the index of a specified item in the vector.
InsertAt(UInt32, T)	Inserts an item at a specified index in the vector.
RemoveAt(UInt32)	Removes the item at the specified index in the vector.
RemoveAtEnd()	Removes the last item from the vector.
ReplaceAll(T[])	Replaces all the items in the vector with the specified items.
SetAt(UInt32, T)	Sets the value at the specified index in the vector.

Applies to

Jaa