BinaryPrimitives.TryReadUInt16BigEndian 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 big endian.

public:
 static bool TryReadUInt16BigEndian(ReadOnlySpan<System::Byte> source, [Runtime::InteropServices::Out] System::UInt16 % value);

[System.CLSCompliant(false)]
public static bool TryReadUInt16BigEndian (ReadOnlySpan<byte> source, out ushort value);

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

Public Shared Function TryReadUInt16BigEndian (source As ReadOnlySpan(Of Byte), ByRef value As UShort) As Boolean

Parameters

source

ReadOnlySpan<Byte>

The read-only span of bytes to read.

value

UInt16

When this method returns, contains the value read out of the read-only span of bytes, as big endian.

Returns

Boolean

true if the span is large enough to contain a UInt16; otherwise, false.

Attributes

CLSCompliantAttribute

Remarks

Reads exactly 2 bytes from the beginning of the span.