CastArrayTFrom, TToGetElementReference Method

Gets the reference to the element at the specified index.

Definition

Namespace: KGySoft.Collections
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 10.5.0

C#

public ref TTo GetElementReference(
	int index
)

VB

Public Function GetElementReference ( 
	index As Integer
) As TTo

C++

public:
TTo% GetElementReference(
	int index
)

F#

member GetElementReference : 
        index : int -> 'TTo

Parameters

index Int32: The index of the element to get the reference for.

Return Value

TTo
The reference to the element at the specified index.

Remarks

This method validates index against Length. To allow getting any reference from the actual underlying array use the GetElementReferenceUnsafe method instead.

Caution

If TTo is a primitive type of size larger than 1 byte, and the executing architecture does not support misaligned memory access, a DataMisalignedException can be thrown in the moment of dereferencing the result if it its address is not properly aligned.

Note

This method returns a value by reference. If this library is used by an older compiler that does not support such members, use the indexer instead.

Exceptions

IndexOutOfRangeException	index is less than zero or greater or equal to Length.
VerificationException	.NET Framework only: you execute this method in a partially trusted AppDomain that does not allow executing unverifiable code.