This structure returns information about a decoded barcode. More...
Public Attributes | |
short | angle_of_distortion |
This property contains the angle of distortion in degree multiplied with a factor of 10 . | |
short | axial_nonuniformity |
This property contains the axial nonuniformity multiplied with a factor of 100 . | |
short | bar1 |
This property specifies if the bar 1 is present, miss or don't care. | |
short | bar2 |
This property specifies if the bar 2 is present, miss or don't care. | |
short | bar3 |
This property specifies if the bar 3 is present, miss or don't care. | |
short | bar4 |
This property specifies if the bar 4 is present, miss or don't care. | |
short | bar5 |
This property specifies if the bar 5 is present, miss or don't care. | |
short | bar6 |
This property specifies if the bar 6 is present, miss or don't care. | |
short | bar7 |
This property specifies if the bar 7 is present, miss or don't care. | |
short | bar8 |
This property specifies if the bar 8 is present, miss or don't care. | |
short | char_read |
The char_read element contains the number of characters in the read barcode. | |
short | char_truncated |
The char_truncated element specifies the number of characters which could not be entered in the field specified by the user because it was too small. | |
short | code_out_of_aoi |
This flag will be set if parts of the code are outside the area of interest while calculating the QR grading results. | |
short | code_position_status |
short | code_position_x1 |
X-coordinate of edge 1 of the code. | |
short | code_position_x2 |
X-coordinate of edge 2 of the code. | |
short | code_position_x3 |
X-coordinate of edge 3 of the code. | |
short | code_position_x4 |
X-coordinate of edge 4 of the code. | |
short | code_position_xm |
short | code_position_y1 |
Y-coordinate of edge 1 of the code. | |
short | code_position_y2 |
Y-coordinate of edge 2 of the code. | |
short | code_position_y3 |
Y-coordinate of edge 3 of the code. | |
short | code_position_y4 |
Y-coordinate of edge 4 of the code. | |
short | code_position_ym |
short | code_quiet_zone_out_of_aoi |
This flag will be set if parts of the code's quiet zone are outside the area of interest while calculating the QR grading results. | |
short | code_rotation |
short | contrast |
The contrast element contains the minimal contrast in the code. | |
short | contrast1 |
This property specifies the contrast of bar1. | |
short | contrast2 |
This property specifies the contrast of bar2. | |
short | contrast3 |
This property specifies the contrast of bar3. | |
short | contrast4 |
This property specifies the contrast of bar4. | |
short | contrast5 |
This property specifies the contrast of bar5. | |
short | contrast6 |
This property specifies the contrast of bar6. | |
short | contrast7 |
This property specifies the contrast of bar7. | |
short | contrast8 |
This property specifies the contrast of bar8. | |
short | decoding_result |
Decoding result. | |
short | decoding_time |
The decoding_time specifies the time consumed for decoding in units of ms. | |
short | ecc_level |
Ecc level. | |
short | error_reason |
Error reason. | |
short | fnc1 |
Special flag used with the Code 128. | |
short | fnc2 |
Special flag used with the Code 128. | |
short | fnc3 |
Special flag used with the Code 128. | |
short | fnc4 |
Special flag used with the Code 128. | |
short | format |
Format parameter. | |
short | full_ascii |
The full_ascii element specifies the use of a full ascii description of the code, only used with the Code 39 and the Code 93. | |
short | global_threshold |
Global threshold found during grading. | |
short | grade_axial_nonuniformity |
This property contains the grade of the axial nonuniformity (ranging from 0 to 4 ). | |
short | grade_fixed_pattern_damage |
This property contains the fixed pattern damage grade (ranging from 0 to 4 ). | |
short | grade_format_information |
This property contains the format information grade (ranging from 0 to 4 ). | |
short | grade_grid_nonuniformity |
This property contains the grade of the grid nonuniformity (ranging from 0 to 4 ). | |
short | grade_modulation |
This property contains the modulation grade (ranging from 0 to 4 ). | |
short | grade_print_growth |
This property contains the grade of the print growth (ranging from 0 to 4 ). | |
short | grade_reference_decode |
This property indicates if the decoding algorithm was able to decode the code. If it achieves a valid decode, the decode grade is 4 , otherwise it is 0 . | |
short | grade_symbol_contrast |
This property contains the grade of the symbol contrast (ranging from 0 to 4 ). | |
short | grade_unused_error_correction |
This property contains the grade of the unused error correction (ranging from 0 to 4 ). | |
short | grade_version_information |
This property contains the version information grade (ranging from 0 to 4 ). | |
short | grid_nonuniformity |
This property contains the grid nonuniformity multiplied with a factor of 100 . | |
short | high_level_codepage |
short | high_level_error |
short | high_level_fnc1 |
short | high_level_macro_05 |
short | high_level_macro_06 |
short | high_level_reader_pro |
short | high_level_structured_append_file_id |
short | high_level_structured_append_position |
short | high_level_structured_append_total |
short | high_level_symbology_modifier_character |
short | num_columns |
The num_columns element specifies the num of columns of the code, only with Data Matrix and PDF 417. | |
short | num_digits |
The num_digits element contains the number of code words composing the read barcode. | |
short | num_rows |
The num_rows element specifies the num of rows of the code, only with Data Matrix and PDF 417. | |
short | number_system |
Number system. | |
short | p1_x |
The p1_x element describes the x-coordinate of the first edge point of the detected code. | |
short | p1_y |
The p1_y element describes the y-coordinate of the first edge point of the detected code. | |
short | p2_x |
The p2_x element describes the x-coordinate of the second edge point of the detected code. | |
short | p2_y |
The p2_y element describes the y-coordinate of the second edge point of the detected code. | |
short | p3_x |
The p3_x element describes the x-coordinate of the third edge point of the detected code. | |
short | p3_y |
The p3_y element describes the y-coordinate of the third edge point of the detected code. | |
short | p4_x |
The p4_x element describes the x-coordinate of the fourth edge point of the detected code. | |
short | p4_y |
The p4_y element describes the y-coordinate of the fourth edge point of the detected code. | |
short | print_growth |
This property contains the print growth multiplied with a factor of 100 . | |
CVC_BC_QUALITY_INFO | quality_info |
1D Code Grading Results. | |
short | r_max |
Maximum contrast found during grading. | |
short | r_min |
Minimum contrast found during grading. | |
short | resolution |
The resolution specifies the smallest width unit in the code in multiples of a 10th of a pixel. | |
short | scan_grade |
This property contains the "scan grade" which is the lowest of the parameter grades achieved above. | |
short | search_direction |
short | search_radius |
short | start_position_x |
short | start_position_y |
short | subgrade_a1 |
This is one of the sub grades on which the calculation of the fixed_pattern_damage grade is based. | |
short | subgrade_a2 |
This is one of the sub grades on which the calculation of the fixed_pattern_damage grade is based. | |
short | subgrade_a3 |
This is one of the sub grades on which the calculation of the fixed_pattern_damage grade is based. | |
short | subgrade_b1 |
This is one of the sub grades on which the calculation of the fixed_pattern_damage grade is based. | |
short | subgrade_b2 |
This is one of the sub grades on which the calculation of the fixed_pattern_damage grade is based. | |
short | subgrade_c |
This is one of the sub grades on which the calculation of the fixed_pattern_damage grade is based. | |
short | symbol_contrast |
This property contains the symbol contrast in %. | |
short | type |
The type element contains one of the constants from CVC_BC_TYPE. This can also be CVC_BC_NOREAD if no barcode has been recognised. | |
short | unused_error_correction |
This property contains the unused error correction in %. | |
short | used_ecc |
The used_ecc element specifies the used ecc for the error correction in %. | |
This structure returns information about a decoded barcode.
When the function CvcBcDecodeBarcode is called, a pointer to this type of structure is passed. After the call this structure contains information about the recognised barcode.
If a barcode cannot be read, it is possible to obtain more detailed information about the barcode evaluation via the elements decoding_result and error_reason. Only those elements of the info-structure will be filled for which informations were available at the moment the evaluation stopped.
code_position_x3, code_position_y3, code_position_x4, decoding_result, and error_reason.
short angle_of_distortion |
short axial_nonuniformity |
short bar1 |
short bar2 |
short bar3 |
short bar4 |
short bar5 |
short bar6 |
short bar7 |
short bar8 |
short char_read |
The char_read element contains the number of characters in the read barcode.
This value is also returned by the CvcBcDecodeBarcode function as the function result.
short char_truncated |
short code_out_of_aoi |
short code_position_x1 |
X-coordinate of edge 1 of the code.
The parameters code_position_x1, code_position_y1, code_position_x2, code_position_y2, code_position_x3, code_position_y3, code_position_x4, and code_position_y4 define all 4 edges of a code, but only when this feature is enabled.
This is independent from the type of code read. Furthermore, it provides the centre of gravity as well as the rotation of the code. The rotation is denoted clockwise in the general case. If the code is mirrored, the angle is given counterclockwise.
short code_position_x2 |
X-coordinate of edge 2 of the code.
The parameters code_position_x1, code_position_y1, code_position_x2, code_position_y2, code_position_x3, code_position_y3, code_position_x4, and code_position_y4 define all 4 edges of a code, but only when this feature is enabled.
This is independent from the type of code read. Furthermore, it provides the centre of gravity as well as the rotation of the code. The rotation is denoted clockwise in the general case. If the code is mirrored, the angle is given counterclockwise.
short code_position_x3 |
X-coordinate of edge 3 of the code.
The parameters code_position_x1, code_position_y1, code_position_x2, code_position_y2, code_position_x3, code_position_y3, code_position_x4, and code_position_y4 define all 4 edges of a code, but only when this feature is enabled.
This is independent from the type of code read. Furthermore, it provides the centre of gravity as well as the rotation of the code. The rotation is denoted clockwise in the general case. If the code is mirrored, the angle is given counterclockwise.
short code_position_x4 |
X-coordinate of edge 4 of the code.
The parameters code_position_x1, code_position_y1, code_position_x2, code_position_y2, code_position_x3, code_position_y3, code_position_x4, and code_position_y4 define all 4 edges of a code, but only when this feature is enabled.
This is independent from the type of code read. Furthermore, it provides the centre of gravity as well as the rotation of the code. The rotation is denoted clockwise in the general case. If the code is mirrored, the angle is given counterclockwise.
short code_position_y1 |
Y-coordinate of edge 1 of the code.
The parameters code_position_x1, code_position_y1, code_position_x2, code_position_y2, code_position_x3, code_position_y3, code_position_x4, and code_position_y4 define all 4 edges of a code, but only when this feature is enabled.
This is independent from the type of code read. Furthermore, it provides the centre of gravity as well as the rotation of the code. The rotation is denoted clockwise in the general case. If the code is mirrored, the angle is given counterclockwise.
short code_position_y2 |
Y-coordinate of edge 2 of the code.
The parameters code_position_x1, code_position_y1, code_position_x2, code_position_y2, code_position_x3, code_position_y3, code_position_x4, and code_position_y4 define all 4 edges of a code, but only when this feature is enabled.
This is independent from the type of code read. Furthermore, it provides the centre of gravity as well as the rotation of the code. The rotation is denoted clockwise in the general case. If the code is mirrored, the angle is given counterclockwise.
short code_position_y3 |
Y-coordinate of edge 3 of the code.
The parameters code_position_x1, code_position_y1, code_position_x2, code_position_y2, code_position_x3, code_position_y3, code_position_x4, and code_position_y4 define all 4 edges of a code, but only when this feature is enabled.
This is independent from the type of code read. Furthermore, it provides the centre of gravity as well as the rotation of the code. The rotation is denoted clockwise in the general case. If the code is mirrored, the angle is given counterclockwise.
short code_position_y4 |
Y-coordinate of edge 4 of the code.
The parameters code_position_x1, code_position_y1, code_position_x2, code_position_y2, code_position_x3, code_position_y3, code_position_x4, and code_position_y4 define all 4 edges of a code, but only when this feature is enabled.
This is independent from the type of code read. Furthermore, it provides the centre of gravity as well as the rotation of the code. The rotation is denoted clockwise in the general case. If the code is mirrored, the angle is given counterclockwise.
short code_quiet_zone_out_of_aoi |
short contrast |
short contrast1 |
This property specifies the contrast of bar1.
short contrast2 |
This property specifies the contrast of bar2.
short contrast3 |
This property specifies the contrast of bar3.
short contrast4 |
This property specifies the contrast of bar4.
short contrast5 |
This property specifies the contrast of bar5.
short contrast6 |
This property specifies the contrast of bar6.
short contrast7 |
This property specifies the contrast of bar7.
short contrast8 |
This property specifies the contrast of bar8.
short decoding_result |
Decoding result.
Possible values are: CVC_BC_SUCCESS,
CVC_BC_NOTHING_FOUND,
CVC_BC_SYMBOLOGY_ONLY,
CVC_BC_WRONG_CODE_SIZE,
CVC_BC_WRONG_CODE_FORMAT,
CVC_BC_ERROR_DETECTION_FAILED,
CVC_BC_COLOR_NOT_CORRECT, and
CVC_BC_BREAK_BY_ERROR.
short ecc_level |
short error_reason |
Error reason.
Following values are possible:
CVC_BC_NO_ERROR,
CVC_BC_NO_MEMORY,
CVC_BC_PARAMETER_ERROR,
CVC_BC_PARAMETER_WARNING,
CVC_BC_NO_DONGLE,
CVC_BC_INVALID_LICENCE_NUMBER,
CVC_BC_WRONG_LICENCE_NUMBER,
CVC_BC_FILE_NOT_FOUND,
CVC_BC_FILE_NOT_WRITEABLE,
CVC_BC_NOT_INITIALZED,
CVC_BC_TIMELIMIT_REACHED,
CVC_BC_DATA_FORMAT_ERROR,
CVC_BC_NO_IMAGE,
CVC_BC_NOT_8BIT,
CVC_BC_INVALID_PLANE, CVC_BC_INVALID_RECT, and
CVC_BC_NO_FREE_CONFIGURATION.
short fnc1 |
Special flag used with the Code 128.
The fnc1 flag is used to show if it is a Code 128 or an EAN128. If the value is 0
it is an EAN 128, if the value is 1
it is a Code 128.
In case of a SonyCode this property contains the radius code. The element fnc1 contains the radius in 10th of a mm. The value is in the range from 190
to 588
. The radius code is only calculated when the parameter code_interpretation (see CvcBcSetSonyCode) is active. If the parameter code_interpretation is active the info-structure element full_ascii will be set to 1
.
short fnc2 |
Special flag used with the Code 128.
In case of a SonyCode this property contains the radius code. The element fnc2 contains the product ID, which ranges from 0
to 7
. The radius code is only calculated when the parameter code_interpretation (see CvcBcSetSonyCode) is active. If the parameter code_interpretation is active the info-structure element full_ascii will be set to 1
.
short format |
short full_ascii |
short global_threshold |
short grade_axial_nonuniformity |
short grade_fixed_pattern_damage |
This property contains the fixed pattern damage grade (ranging from 0
to 4
).
If the fixed pattern damage grading is not active the grading result is -1
. The fixed pattern damage grade is based on the results storedin subgrade_a1, subgrade_a2, subgrade_a3, subgrade_b1, subgrade_b2 and subgrade_c.
short grade_format_information |
short grade_grid_nonuniformity |
short grade_modulation |
short grade_print_growth |
short grade_reference_decode |
short grade_symbol_contrast |
short grade_unused_error_correction |
short grade_version_information |
short grid_nonuniformity |
short num_columns |
short num_digits |
The num_digits element contains the number of code words composing the read barcode.
In general this number is a measure of the absolute size of the barcode and does not usually correspond to the number of characters read. The exact number of num_digits depends on the recognised barcode (see also the example for Code 39 in chapter Fundamentals of barcode acquisition). Start- and stop digits are not counted as code words.
short num_rows |
short number_system |
Number system.
The number_system element specifies the number system which is used with the UPC E code.
In case of a QR code number_system returns the used masking of the QR code. Following values are possible:
Masking unknown = 0
Masking 000 = 1
Masking 001 = 2
Masking 010 = 3
Masking 011 = 4
Masking 100 = 5
Masking 101 = 6
Masking 110 = 7
Masking 111 = 8
short p1_x |
The p1_x element describes the x-coordinate of the first edge point of the detected code.
In case of a SonyCode the properties p1_x, p1_y, p2_x, and p2_y define the image coordinates marking the position where the SonyCode has been read. p1 is located at the begin of the start sign (A) and p2 is always be located at the end of the stop sign (F).
In case of a QR code the edge-points of the code are counterclockwise. If the code is not decoded the markers could be outside the code. If only one marker of the QR code is found, the coordinates are stored here.
short p1_y |
The p1_y element describes the y-coordinate of the first edge point of the detected code.
In case of a SonyCode the properties p1_x, p1_y, p2_x, and p2_y define the image coordinates marking the position where the SonyCode has been read. p1 is located at the begin of the start sign (A) and p2 is always be located at the end of the stop sign (F).
In case of a QR code the edge-points of the code are counterclockwise. If the code is not decoded the markers could be outside the code. If only one marker of the QR code is found, the coordinates are stored here.
short p2_x |
The p2_x element describes the x-coordinate of the second edge point of the detected code.
In case of a SonyCode the properties p1_x, p1_y, p2_x, and p2_y define the image coordinates marking the position where the SonyCode has been read. p1 is located at the begin of the start sign (A) and p2 is always be located at the end of the stop sign (F).
In case of a QR code the edge-points of the code are counterclockwise. If the code is not decoded the markers could be outside the code. If only one marker of the QR code is found, the coordinates are stored here.
short p2_y |
The p2_y element describes the y-coordinate of the second edge point of the detected code.
In case of a SonyCode the properties p1_x, p1_y, p2_x, and p2_y define the image coordinates marking the position where the SonyCode has been read. p1 is located at the begin of the start sign (A) and p2 is always be located at the end of the stop sign (F).
In case of a QR code the edge-points of the code are counterclockwise. If the code is not decoded the markers could be outside the code. If only one marker of the QR code is found, the coordinates are stored here.
short p3_x |
The p3_x element describes the x-coordinate of the third edge point of the detected code.
In case of a SonyCode the properties p1_x, p1_y, p2_x, and p2_y define the image coordinates marking the position where the SonyCode has been read. p1 is located at the begin of the start sign (A) and p2 is always be located at the end of the stop sign (F).
In case of a QR code the edge-points of the code are counterclockwise. If the code is not decoded the markers could be outside the code. If only one marker of the QR code is found, the coordinates are stored here.
short p3_y |
The p3_y element describes the y-coordinate of the third edge point of the detected code.
In case of a QR code the edge-points of the code are counterclockwise. If the code is not decoded the markers could be outside the code. If only one marker of the QR code is found, the coordinates are stored here.
short p4_x |
The p4_x element describes the x-coordinate of the fourth edge point of the detected code.
In case of a QR code the edge-points of the code are counterclockwise. If the code is not decoded the markers could be outside the code. If only one marker of the QR code is found, the coordinates are stored here.
short p4_y |
The p4_y element describes the y-coordinate of the fourth edge point of the detected code.
In case of a QR code the edge-points of the code are counterclockwise. If the code is not decoded the markers could be outside the code. If only one marker of the QR code is found, the coordinates are stored here.
short print_growth |
CVC_BC_QUALITY_INFO quality_info |
short r_max |
short r_min |
short resolution |
short scan_grade |
short subgrade_a1 |
short subgrade_a2 |
short subgrade_a3 |
short subgrade_b1 |
short subgrade_b2 |
short subgrade_c |
short symbol_contrast |
short type |
The type element contains one of the constants from CVC_BC_TYPE. This can also be CVC_BC_NOREAD if no barcode has been recognised.
In case of a QR code the type contains one of the constants from CVC_BC_QR.
short unused_error_correction |