AsnDecoder.TryReadCharacterString Method

Definition

Namespace:

System.Formats.Asn1

Assembly:

System.Formats.Asn1.dll

Source:

AsnDecoder.Text.cs

Reads a character string value from source with a specified tag under the specified encoding rules, copying the decoded string into a provided destination buffer.

public static bool TryReadCharacterString (ReadOnlySpan<byte> source, Span<char> destination, System.Formats.Asn1.AsnEncodingRules ruleSet, System.Formats.Asn1.UniversalTagNumber encodingType, out int bytesConsumed, out int charsWritten, System.Formats.Asn1.Asn1Tag? expectedTag = default);

static member TryReadCharacterString : ReadOnlySpan<byte> * Span<char> * System.Formats.Asn1.AsnEncodingRules * System.Formats.Asn1.UniversalTagNumber * int * int * Nullable<System.Formats.Asn1.Asn1Tag> -> bool

Public Shared Function TryReadCharacterString (source As ReadOnlySpan(Of Byte), destination As Span(Of Char), ruleSet As AsnEncodingRules, encodingType As UniversalTagNumber, ByRef bytesConsumed As Integer, ByRef charsWritten As Integer, Optional expectedTag As Nullable(Of Asn1Tag) = Nothing) As Boolean

Parameters

source

ReadOnlySpan<Byte>

The buffer containing encoded data.

destination

Span<Char>

The buffer in which to write.

ruleSet

AsnEncodingRules

The encoding constraints to use when interpreting the data.

encodingType

UniversalTagNumber

One of the enumeration values which represents the value type to process.

bytesConsumed

Int32

When this method returns, the total number of bytes for the encoded value. This parameter is treated as uninitialized.

charsWritten

Int32

When this method returns, the number of chars written to destination. This parameter is treated as uninitialized.

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

ruleSet is not defined.

-or-

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.