BinaryPrimitives.ReadUInt16LittleEndian(ReadOnlySpan<Byte>) Method

Definition

Namespace:

System.Buffers.Binary

Assembly:

System.Memory.dll

Source:

BinaryPrimitives.ReadBigEndian.cs

Important

This API is not CLS-compliant.

Reads a UInt16 from the beginning of a read-only span of bytes, as little endian.

public:
 static System::UInt16 ReadUInt16LittleEndian(ReadOnlySpan<System::Byte> source);

[System.CLSCompliant(false)]
public static ushort ReadUInt16LittleEndian (ReadOnlySpan<byte> source);

[<System.CLSCompliant(false)>]
static member ReadUInt16LittleEndian : ReadOnlySpan<byte> -> uint16

Public Shared Function ReadUInt16LittleEndian (source As ReadOnlySpan(Of Byte)) As UShort

Parameters

source

ReadOnlySpan<Byte>

The read-only span to read.

Returns

UInt16

The little endian value.

Attributes

CLSCompliantAttribute

Exceptions

ArgumentOutOfRangeException

source is too small to contain a UInt16.

Remarks

Reads exactly 2 bytes from the beginning of the span.