ReadSingleCode_Z


Reads a single 1D barcode or a PDF417 code.

Applications:High-speed barcode reading with simple configuration.

Syntax

C++
C#
Python
 
def ReadSingleCode_Z(
	state: ZCode_State,
	inImage: Image,
	/,
	*,
	inLoadConfigFile: str | None = None,
	inSaveConfigFile: str | None = None,
	inTimeout: int | None = None,
	inThreadCount: int | None = None,
	inCode1DSettings: Code1DSettings = Code1DSettings(True, ZCodePolarity.Normal, 80, False, False, False),
	inEnablePDF417: bool = True,
	inEnableCode128: bool = True,
	inEnableCode39: bool = False,
	inEnableCode93: bool = False,
	inEnableInterleaved2of5: bool = False,
	inEnableNoRead: bool = False,
	inEnableQualityMetrics: bool = False
)
-> (
	outResult: ZResult | None,
	outQualityMetrics: ZQualityMetrics | None,
	outNoReadResult: ZNoReadResult | None
)

Parameters

Name Type Range Default Description
Input will be modified ioState ZCode_State
Input value inImage Image Input image
Input value inLoadConfigFile str | None None Configuration file to be loaded in .bin format. Used to restore previously saved settings - can overwrite other parameters.
Input value inSaveConfigFile str | None None Path to save configuration file in .bin format. Used to save current settings for future use.
Input value inTimeout int | None 1 - None Processing timeout in ms
Input value inThreadCount int | None 1 - 31 None Number of processing threads
Input value inCode1DSettings Code1DSettings Code1DSettings(True, ZCodePolarity.Normal, 80, False, False, False) Code1D settings
Input value inEnablePDF417 bool True
Input value inEnableCode128 bool True
Input value inEnableCode39 bool False
Input value inEnableCode93 bool False
Input value inEnableInterleaved2of5 bool False
Input value inEnableNoRead bool False Enable return of the no read results
Input value inEnableQualityMetrics bool False Enable return of quality metrics
Output value outResult ZResult | None Decode results
Output value outQualityMetrics ZQualityMetrics | None Quality metrics of decoded codes
Output value outNoReadResult ZNoReadResult | None No read result - code outline with the reason why it was not decoded