AsnReader.TryReadBitString Method

Definition

Namespace:

System.Formats.Asn1

Assembly:

System.Formats.Asn1.dll

Package:

System.Formats.Asn1 v9.0.0-preview.3.24172.9

Source:

AsnDecoder.BitString.cs

Reads the next value as a BIT STRING with a specified tag, copying the value into a provided destination buffer.

public bool TryReadBitString (Span<byte> destination, out int unusedBitCount, out int bytesWritten, System.Formats.Asn1.Asn1Tag? expectedTag = default);

member this.TryReadBitString : Span<byte> * int * int * Nullable<System.Formats.Asn1.Asn1Tag> -> bool

Public Function TryReadBitString (destination As Span(Of Byte), ByRef unusedBitCount As Integer, ByRef bytesWritten As Integer, Optional expectedTag As Nullable(Of Asn1Tag) = Nothing) As Boolean

Parameters

destination

Span<Byte>

The buffer in which to write.

unusedBitCount

Int32

On success, receives the number of bits in the last byte which were reported as "unused" by the writer.

bytesWritten

Int32

On success, receives the number of bytes written to destination.

expectedTag

Nullable<Asn1Tag>

The tag to check for before reading, or null for the default tag (Universal 1).

Returns

Boolean

true and advances the reader if destination had sufficient length to receive the value, otherwise false and the reader does not advance.

Exceptions

AsnContentException

The next value does not have the correct tag.

-or-

The length encoding is not valid under the current encoding rules.

-or-

The contents are not valid under the current encoding rules.

ArgumentException

expectedTag.TagClass is Universal, but expectedTag.TagValue is not correct for the method.