layout | title | description | keywords | needAutoGenerateSidebar | breadcrumbText | permalink |
---|---|---|---|---|---|---|
default-layout |
Main Page - Dynamsoft Barcode Reader SDK C++ Edition API Reference |
This is the main page of Dynamsoft Barcode Reader SDK C++ Edition API Reference. |
api reference, c++ |
false |
API Reference |
/programming/cplusplus/api-reference/index-v8.1.2.html |
Method | Description |
---|---|
CBarcodeReader |
Default constructor of CBarcodeReader object. |
~CBarcodeReader |
Destructor of CBarcodeReader object. |
Method | Description |
---|---|
DecodeFile |
Decode barcodes from a specified image file. |
DecodeFileInMemory |
Decode barcodes from an image file in memory. |
DecodeBuffer |
Decode barcodes from raw buffer. |
DecodeBase64String |
Decode barcodes from a base64 encoded string. |
DecodeDIB |
Decode barcode from a handle of device-independent bitmap (DIB). |
InitIntermediateResult |
Inits an intermediateResult struct with default values. |
DecodeIntermediateResults |
Decodes barcode from intermediate results. |
Method | Description |
---|---|
SetModeArgument |
Set argument value for the specified mode parameter. |
GetModeArgument |
Get argument value for the specified mode parameter. |
GetRuntimeSettings |
Get current runtime settings. |
UpdateRuntimeSettings |
Modify and update the current runtime settings. |
ResetRuntimeSettings |
Reset runtime settings to default. |
Method | Description |
---|---|
InitRuntimeSettingsWithFile |
Initialize runtime settings with the settings in a given JSON file. |
InitRuntimeSettingsWithString |
Initialize runtime settings with the settings in a given JSON string. |
AppendTplFileToRuntimeSettings |
Append a new template file to the current runtime settings. |
AppendTplStringToRuntimeSettings |
Append a new template string to the current runtime settings. |
GetParameterTemplateCount |
Get the count of the parameter templates. |
GetParameterTemplateName |
Get the parameter template name by index. |
OutputSettingsToFile |
Output runtime settings to a settings file (JSON file). |
OutputSettingsToString |
Output runtime settings to a string. |
OutputSettingsToStringPtr |
Output runtime settings to a string. |
FreeSettingsString |
Free memory allocated for runtime settings string. |
Method | Description |
---|---|
InitLicense |
Read product key and activate the SDK. |
InitLicenseFromServer |
Initialize license and connect to the specified server for online verification. |
InitLicenseFromLicenseContent |
Initialize license from the license content on client machine for offline verification. |
OutputLicenseToString |
Output the license content to a string from the license server. |
OutputLicenseToStringPtr |
Output the license content to a string from the license server. |
FreeLicenseString |
Free memory allocated for the license string. |
InitLTSConnectionParameters |
Initializes a DM_LTSConnectionParameters struct with default values. |
InitLicenseFromLTS |
Initializes the barcode reader license and connects to the specified server for online verification. |
Method | Description |
---|---|
GetAllTextResults |
Get all recognized barcode results. |
FreeTextResults |
Free memory allocated for text results. |
GetIntermediateResults |
Get intermediate results. |
FreeIntermediateResults |
Free memory allocated for the intermediate results. |
Method | Description |
---|---|
GetErrorString |
Get error message by error code. |
GetVersion |
Get version information of SDK. |
Method | Description |
---|---|
StartFrameDecoding |
Decode barcodes from inner frame queue. |
StartFrameDecodingEx |
Decode barcodes from inner frame queue. |
AppendFrame |
Append a frame image buffer to the inner frame queue. |
StopFrameDecoding |
Stop thread used for frame decoding. |
Method | Description |
---|---|
InitFrameDecodingParameters |
Initialize frame decoding parameter. |
Method | Description |
---|---|
SetErrorCallback |
Set callback function to process errors which is triggered when the library finishes decoding a frame. |
SetTextResultCallback |
Set callback function to process text results which is triggered when the library finishes decoding a frame. |
SetIntermediateResultCallback |
Set callback function to process intermediate results which is triggered when the library finishes decoding a frame. |
Method | Description |
---|---|
GetLengthOfFrameQueue |
Get length of current inner frame queue. |
Attribute | Description |
---|---|
m_pBarcodeReader |
Function | Description |
---|---|
CB_Error |
Represents the method that will handle the error code returned by the SDK. |
CB_IntermediateResult |
Represents the method that will handle the intermediate result array returned by the SDK. |
CB_TextResult |
Represents the method that will handle the text result array returned by the SDK. |
- [
AztecDetails
]({{ site.structs }}AztecDetails.html?src=cpp) - [
Contour
]({{ site.structs }}Contour.html?src=cpp) - [
DBRPoint
]({{ site.structs }}DBRPoint.html?src=cpp) - [
DataMatrixDetails
]({{ site.structs }}DataMatrixDetails.html?src=cpp) - [
DM_LTSConnectionParameters
]({{ site.structs }}DMLTSConnectionParameters.html?src=cpp) - [
ExtendedResult
]({{ site.structs }}ExtendedResult.html?src=cpp) - [
FrameDecodingParameters
]({{ site.structs }}FrameDecodingParameters.html?src=cpp) - [
FurtherModes
]({{ site.structs }}FurtherModes.html?src=cpp) - [
ImageData
]({{ site.structs }}ImageData.html?src=cpp) - [
IntermediateResult
]({{ site.structs }}IntermediateResult.html?src=cpp) - [
IntermediateResultArray
]({{ site.structs }}IntermediateResultArray.html?src=cpp) - [
LineSegment
]({{ site.structs }}LineSegment.html?src=cpp) - [
LocalizationResult
]({{ site.structs }}LocalizationResult.html?src=cpp) - [
OneDCodeDetails
]({{ site.structs }}OneDCodeDetails.html?src=cpp) - [
PDF417Details
]({{ site.structs }}PDF417Details.html?src=cpp) - [
PublicRuntimeSettings
]({{ site.structs }}PublicRuntimeSettings.html?src=cpp) - [
QRCodeDetails
]({{ site.structs }}QRCodeDetails.html?src=cpp) - [
Quadrilateral
]({{ site.structs }}Quadrilateral.html?src=cpp) - [
RegionDefinition
]({{ site.structs }}RegionDefinition.html?src=cpp) - [
RegionOfInterest
]({{ site.structs }}RegionOfInterest.html?src=cpp) - [
SamplingImageData
]({{ site.structs }}SamplingImageData.html?src=cpp) - [
TextResult
]({{ site.structs }}TextResult.html?src=cpp) - [
TextResultArray
]({{ site.structs }}TextResultArray.html?src=cpp)
- [
AccompanyingTextRecognitionMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#accompanyingtextrecognitionmode) - [
BarcodeColourMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#barcodecolourmode) - [
BarcodeComplementMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#barcodecomplementmode) - [
BarcodeFormat
]({{ site.c_cpp_enumerations }}format-enums.html?src=cpp#barcodeformat) - [
BarcodeFormat_2
]({{ site.c_cpp_enumerations }}format-enums.html?src=cpp#barcodeformat_2) - [
BinarizationMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#binarizationmode) - [
ClarityCalculationMethod
]({{ site.c_cpp_enumerations }}frame-decoding-enums.html?src=cpp#claritycalculationmethod) - [
ClarityFilterMode
]({{ site.c_cpp_enumerations }}frame-decoding-enums.html?src=cpp#clarityfiltermode) - [
ColourClusteringMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#colourclusteringmode) - [
ColourConversionMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#colourconversionmode) - [
ConflictMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#conflictmode) - [
DeblurMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#deblurmode) - [
DeformationResistingMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#deformationresistingmode) - [
DM_ChargeWay
]({{ site.c_cpp_enumerations }}other-enums.html?src=cpp#dm_chargeway) - [
DM_DeploymentType
]({{ site.c_cpp_enumerations }}other-enums.html?src=cpp#dm_deploymenttype) - [
DM_LicenseModule
]({{ site.c_cpp_enumerations }}other-enums.html?src=cpp#dm_licensemodule) - [
DM_UUIDGenerationMethod
]({{ site.c_cpp_enumerations }}other-enums.html?src=cpp#dm_uuidgenerationmethod) - [
DPMCodeReadingMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#dpmcodereadingmode) - [
GrayscaleTransformationMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#grayscaletransformationmode) - [
ImagePixelFormat
]({{ site.c_cpp_enumerations }}other-enums.html?src=cpp#imagepixelformat) - [
ImagePreprocessingMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#imagepreprocessingmode) - [
IMResultDataType
]({{ site.c_cpp_enumerations }}result-enums.html?src=cpp#imresultdatatype) - [
IntermediateResultSavingMode
]({{ site.c_cpp_enumerations }}result-enums.html?src=cpp#intermediateresultsavingmode) - [
IntermediateResultType
]({{ site.c_cpp_enumerations }}result-enums.html?src=cpp#intermediateresulttype) - [
LocalizationMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#localizationmode) - [
PDFReadingMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#pdfreadingmode) - [
QRCodeErrorCorrectionLevel
]({{ site.c_cpp_enumerations }}other-enums.html?src=cpp#qrcodeerrorcorrectionlevel) - [
RegionPredetectionMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#regionpredetectionmode) - [
ResultCoordinateType
]({{ site.c_cpp_enumerations }}result-enums.html?src=cpp#resultcoordinatetype) - [
ResultType
]({{ site.c_cpp_enumerations }}result-enums.html?src=cpp#resulttype) - [
ScaleUpMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#scaleupmode) - [
TerminatePhase
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#terminatephase) - [
TextAssistedCorrectionMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#textassistedcorrectionmode) - [
TextFilterMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#textfiltermode) - [
TextResultOrderMode
]({{ site.c_cpp_enumerations }}result-enums.html?src=cpp#textresultordermode) - [
TextureDetectionMode
]({{ site.c_cpp_enumerations }}parameter-mode-enums.html?src=cpp#texturedetectionmode)