AsnReader.TryReadCharacterString Method

Definition

Namespace:

System.Formats.Asn1

Assembly:

System.Formats.Asn1.dll

Source:

AsnDecoder.Text.cs

Reads the next value as character string with the specified tag and encoding type, copying the decoded value into a provided destination buffer.

public bool TryReadCharacterString (Span<char> destination, System.Formats.Asn1.UniversalTagNumber encodingType, out int charsWritten, System.Formats.Asn1.Asn1Tag? expectedTag = default);

member this.TryReadCharacterString : Span<char> * System.Formats.Asn1.UniversalTagNumber * int * Nullable<System.Formats.Asn1.Asn1Tag> -> bool

Public Function TryReadCharacterString (destination As Span(Of Char), encodingType As UniversalTagNumber, ByRef charsWritten As Integer, Optional expectedTag As Nullable(Of Asn1Tag) = Nothing) As Boolean

Parameters

destination

Span<Char>

The buffer in which to write.

encodingType

UniversalTagNumber

One of the enumeration values representing the value type to process.

charsWritten

Int32

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

expectedTag

Nullable<Asn1Tag>

The tag to check for before reading, or null for the universal tag that is appropriate to the requested encoding type.

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

ArgumentOutOfRangeException

encodingType is not a known character string type.

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.

-or-

The string did not successfully decode.

ArgumentException

expectedTag.TagClass is Universal, but expectedTag.TagValue is not the same as encodingType.