QRCodeDecodeResult Class

Namespace: Meziantou.Framework.Barcodes
Assembly: Meziantou.Framework.Barcodes.dll
Package: Meziantou.Framework.Barcodes 1.0.5
Source: QRCodeDecodeResult.cs
Available in package assets: net10.0net11.0

Represents the content of a QR code read by QRCodeDecoder: its data and the parameters of the symbol.

public sealed class QRCodeDecodeResult

Properties

Name	Description
CorrectedErrorCount	Gets the number of codewords that the error correction fixed.
ErrorCorrectionLevel	Gets the error correction level of the symbol. Micro QR version M1, which detects errors only, reports `ErrorCorrectionLevel.L`.
IsMirrored	Gets whether the symbol was read mirrored: its rows and columns were swapped. Only square symbols (standard and Micro QR codes) are read mirrored.
MaskPattern	Gets the data mask pattern of the symbol: 0 to 7 in a standard QR code, 0 to 3 in a Micro QR code, or `null` for an rMQR code, which has a single mask.
Segments	Gets the segments of the data, in order, with their ECI designators.
StructuredAppend	Gets the place of the symbol in a structured append sequence, or `null` when the symbol holds all of its data. Use `QRCodeDecoder.MergeStructuredAppend` to put the data of a sequence back together.
Text	Gets the text of the data. The byte segments are decoded with the character set of the ECI designator that precedes them. Without one, they are decoded as UTF-8 when they are valid UTF-8, and as ISO/IEC 8859-1 otherwise.
Type	Gets the type of the QR code.
Version	Gets the version of the QR code: 1 to 40 for a standard QR code, 1 to 4 for a Micro QR code (M1 to M4), 1 to 32 for an rMQR code.

CorrectedErrorCount

QRCodeDecodeResult.cs

Gets the number of codewords that the error correction fixed.

public int CorrectedErrorCount { get; }

Property value

int

ErrorCorrectionLevel

QRCodeDecodeResult.cs

Gets the error correction level of the symbol. Micro QR version M1, which detects errors only, reports ErrorCorrectionLevel.L.

public ErrorCorrectionLevel ErrorCorrectionLevel { get; }

Property value

ErrorCorrectionLevel

IsMirrored

QRCodeDecodeResult.cs

Gets whether the symbol was read mirrored: its rows and columns were swapped. Only square symbols (standard and Micro QR codes) are read mirrored.

public bool IsMirrored { get; }

Property value

bool

MaskPattern

QRCodeDecodeResult.cs

Gets the data mask pattern of the symbol: 0 to 7 in a standard QR code, 0 to 3 in a Micro QR code, or null for an rMQR code, which has a single mask.

public int? MaskPattern { get; }

Property value

int?

Segments

QRCodeDecodeResult.cs

Gets the segments of the data, in order, with their ECI designators.

public IReadOnlyList<QRCodeSegment> Segments { get; }

Property value

IReadOnlyList<QRCodeSegment>

StructuredAppend

QRCodeDecodeResult.cs

Gets the place of the symbol in a structured append sequence, or null when the symbol holds all of its data. Use QRCodeDecoder.MergeStructuredAppend to put the data of a sequence back together.

public QRCodeStructuredAppend? StructuredAppend { get; }

Property value

QRCodeStructuredAppend?

Text

QRCodeDecodeResult.cs

Gets the text of the data. The byte segments are decoded with the character set of the ECI designator that precedes them. Without one, they are decoded as UTF-8 when they are valid UTF-8, and as ISO/IEC 8859-1 otherwise.