Skip to content

Commit d3fcad0

Browse files
KonstantinAlkhimovKonstantinAlkhimov
committed
restore C++ api reference
1 parent 461f63f commit d3fcad0

File tree

1,223 files changed

+38808
-4
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,223 files changed

+38808
-4
lines changed

‎english/cpp/_index.md‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
11
---
22
title: Aspose.BarCode for C++
3+
linktitle: Aspose.BarCode for C++
34
type: docs
4-
weight: 12
5+
weight: 10
56
url: /cpp/
6-
keywords:
7-
description:
7+
keywords: "Aspose.BarCode for C++, Aspose BarCode, Aspose.BarCode API Reference."
8+
description: "Aspose.BarCode for C++ is a comprehensive library for generating and recognizing barcodes in C++ applications, adhering to modern barcode standards. It offers a robust framework with extensive customization, ease of use, and cross-platform support."
89
is_root: true
9-
---
10+
---
11+
12+
## Namespaces
13+
14+
| Namespace | Description |
15+
| --- | --- |
16+
| [Aspose::BarCode](./aspose.barcode/) | |
17+
| [Aspose::BarCode::BarCodeRecognition](./aspose.barcode.barcoderecognition/) | |
18+
| [Aspose::BarCode::Common](./aspose.barcode.common/) | |
19+
| [Aspose::BarCode::ComplexBarcode](./aspose.barcode.complexbarcode/) | |
20+
| [Aspose::BarCode::Generation](./aspose.barcode.generation/) | |

‎english/cpp/aspose.barcode.barcoderecognition/_index.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: Aspose::BarCode::BarCodeRecognition namespace
3+
linktitle: Aspose::BarCode::BarCodeRecognition
4+
second_title: Aspose.BarCode for C++ API Reference
5+
description: 'How to use Aspose::BarCode::BarCodeRecognition namespace in C++.'
6+
type: docs
7+
weight: 200
8+
url: /cpp/aspose.barcode.barcoderecognition/
9+
---
10+
11+
12+
13+
## Classes
14+
15+
| Class | Description |
16+
| --- | --- |
17+
| [AustraliaPostCustomerInformationDecoder](./australiapostcustomerinformationdecoder/) | Public interface for Customer Information Field decoding which is used in AustraliaPost symbology. Implementation should be provided by user. |
18+
| [AustraliaPostSettings](./australiapostsettings/) | AustraliaPost decoding parameters. Contains parameters which make influence on recognized data of AustraliaPost symbology. |
19+
| [AztecExtendedParameters](./aztecextendedparameters/) | Stores special data of Aztec recognized barcode. |
20+
| [BarCodeExtendedParameters](./barcodeextendedparameters/) | Stores extended parameters of recognized barcode. |
21+
| [BarCodeReader](./barcodereader/) | [BarCodeReader](./barcodereader/) encapsulates an image which may contain one or several barcodes, it then can perform ReadBarCodes operation to detect barcodes. |
22+
| [BarCodeRegionParameters](./barcoderegionparameters/) | Represents the recognized barcode's region and barcode angle. |
23+
| [BarCodeResult](./barcoderesult/) | Stores recognized barcode data like [SingleDecodeType](./singledecodetype/) type, **System::String** codetext, [BarCodeRegionParameters](./barcoderegionparameters/) region and other parameters. |
24+
| [BarcodeSettings](./barcodesettings/) | The main [BarCode](../aspose.barcode/) decoding parameters. Contains parameters which make influence on recognized data. |
25+
| [BaseDecodeType](./basedecodetype/) | Base class for [MultyDecodeType](./multydecodetype/) and [SingleDecodeType](./singledecodetype/). |
26+
| [BaseExtendedParameters](./baseextendedparameters/) | Basic class for extended parameters of recognized barcode storing. |
27+
| [CodabarExtendedParameters](./codabarextendedparameters/) | Stores a Codabar additional information of recognized barcode. |
28+
| [Code128DataPortion](./code128dataportion/) | Contains the data of subtype for Code128 type barcode. |
29+
| [Code128ExtendedParameters](./code128extendedparameters/) | Stores special data of Code128 recognized barcode. |
30+
| [DataBarExtendedParameters](./databarextendedparameters/) | Stores a DataBar additional information of recognized barcode. |
31+
| [DataMatrixExtendedParameters](./datamatrixextendedparameters/) | Stores special data of DataMatrix recognized barcode. |
32+
| [DecodeType](./decodetype/) | Specify the type of barcode to read. |
33+
| [DotCodeExtendedParameters](./dotcodeextendedparameters/) | Stores special data of DotCode recognized barcode. |
34+
| [GS1CompositeBarExtendedParameters](./gs1compositebarextendedparameters/) | Stores special data of **GS1 Composite Bar** recognized barcode. |
35+
| [MaxiCodeExtendedParameters](./maxicodeextendedparameters/) | Stores a MaxiCode additional information of recognized barcode. |
36+
| [MultyDecodeType](./multydecodetype/) | Composite decode type. |
37+
| [OneDExtendedParameters](./onedextendedparameters/) | Stores special data of 1D recognized barcode like separate codetext and checksum. |
38+
| [Pdf417ExtendedParameters](./pdf417extendedparameters/) | Stores a MacroPdf417 metadata information of recognized barcode. |
39+
| [QRExtendedParameters](./qrextendedparameters/) | Stores a QR Structured Append information of recognized barcode. |
40+
| [Quadrangle](./quadrangle/) | Stores a set of four [Point](../)s that represent a [Quadrangle](./quadrangle/) region. |
41+
| [QualitySettings](./qualitysettings/) | [QualitySettings](./qualitysettings/) allows to configure recognition quality and speed manually. You can quickly set up [QualitySettings](./qualitysettings/) with embedded presets: HighPerformance, NormalQuality, HighQuality, MaxQuality or you can manually configure separate options. Default value of [QualitySettings](./qualitysettings/) is NormalQuality. |
42+
| [SingleDecodeType](./singledecodetype/) | Single decode type. See decode type to get instance. |
43+
## Enums
44+
45+
| Enum | Description |
46+
| --- | --- |
47+
| [BarCodeConfidence](./barcodeconfidence/) | Contains recognition confidence level. |
48+
| [BarcodeQualityMode](./barcodequalitymode/) | |
49+
| [ChecksumValidation](./checksumvalidation/) | |
50+
| [Code128SubType](./code128subtype/) | Contains types of Code128 subset. |
51+
| [ComplexBackgroundMode](./complexbackgroundmode/) | |
52+
| [DeconvolutionMode](./deconvolutionmode/) | |
53+
| [InverseImageMode](./inverseimagemode/) | |
54+
| [XDimensionMode](./xdimensionmode/) | |
55+
## Typedefs
56+
57+
| Typedef | Description |
58+
| --- | --- |
59+
| [BarCodeRecognitionException](./barcoderecognitionexception/) | |
60+
| [RecognitionAbortedException](./recognitionabortedexception/) | |

‎english/cpp/aspose.barcode.barcoderecognition/australiapostcustomerinformationdecoder/_index.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Aspose::BarCode::BarCodeRecognition::AustraliaPostCustomerInformationDecoder class
3+
linktitle: AustraliaPostCustomerInformationDecoder
4+
second_title: Aspose.BarCode for C++ API Reference
5+
description: 'Aspose::BarCode::BarCodeRecognition::AustraliaPostCustomerInformationDecoder class. Public interface for Customer Information Field decoding which is used in AustraliaPost symbology. Implementation should be provided by user in C++.'
6+
type: docs
7+
weight: 100
8+
url: /cpp/aspose.barcode.barcoderecognition/australiapostcustomerinformationdecoder/
9+
---
10+
## AustraliaPostCustomerInformationDecoder class
11+
12+
13+
Public interface for Customer Information Field decoding which is used in AustraliaPost symbology. Implementation should be provided by user.
14+
15+
```cpp
16+
class AustraliaPostCustomerInformationDecoder : public virtual System::Object
17+
```
18+
19+
## Methods
20+
21+
| Method | Description |
22+
| --- | --- |
23+
| virtual [Decode](./decode/)(System::String) | Decode Customer Information Field from AustraliaPost symbology. Can be used for different data interpretation from NTable and CTable encoding. Data is provided as a row of bar values: 0, 1, 2 or 3. |
24+
## See Also
25+
26+
* Namespace [Aspose::BarCode::BarCodeRecognition](../)
27+
* Library [Aspose.BarCode for C++](../../)

‎english/cpp/aspose.barcode.barcoderecognition/australiapostcustomerinformationdecoder/decode/_index.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: Aspose::BarCode::BarCodeRecognition::AustraliaPostCustomerInformationDecoder::Decode method
3+
linktitle: Decode
4+
second_title: Aspose.BarCode for C++ API Reference
5+
description: 'Aspose::BarCode::BarCodeRecognition::AustraliaPostCustomerInformationDecoder::Decode method. Decode Customer Information Field from AustraliaPost symbology. Can be used for different data interpretation from NTable and CTable encoding. Data is provided as a row of bar values: 0, 1, 2 or 3 in C++.'
6+
type: docs
7+
weight: 100
8+
url: /cpp/aspose.barcode.barcoderecognition/australiapostcustomerinformationdecoder/decode/
9+
---
10+
## AustraliaPostCustomerInformationDecoder::Decode method
11+
12+
13+
Decode Customer Information Field from AustraliaPost symbology. Can be used for different data interpretation from NTable and CTable encoding. Data is provided as a row of bar values: 0, 1, 2 or 3.
14+
15+
```cpp
16+
virtual System::String Aspose::BarCode::BarCodeRecognition::AustraliaPostCustomerInformationDecoder::Decode(System::String customerInformationField)=0
17+
```
18+
19+
20+
| Parameter | Type | Description |
21+
| --- | --- | --- |
22+
| customerInformationField | System::String | The Customer Information Field encoded as row of raw bar values: 0, 1, 2 or 3 |
23+
24+
### ReturnValue
25+
26+
the decoded Customer Information Field string
27+
## Remarks
28+
29+
30+
31+
This sample shows how to decode data with [AustraliaPostCustomerInformationDecoder](../) interface
32+
```cpp
33+
[C#]
34+
string[] N_Table = { "00", "01", "02", "10", "11", "12", "20", "21", "22", "30" };
35+
public string Decode(string customerInformationField)
36+
{
37+
StringBuilder bd = new StringBuilder();
38+
for (int i = 0; customerInformationField.Length > i; i += 2)
39+
{
40+
if (customerInformationField.Length >= i + 2)
41+
{
42+
string tmp = customerInformationField.Substring(i, 2);
43+
for (int j = 0; N_Table.Length > j; j++)
44+
{
45+
if (N_Table[j].Equals(tmp))
46+
{
47+
bd.Append(j);
48+
break;
49+
}
50+
}
51+
}
52+
}
53+
return bd.ToString();
54+
}
55+
```
56+
57+
## See Also
58+
59+
* Class [AustraliaPostCustomerInformationDecoder](../)
60+
* Namespace [Aspose::BarCode::BarCodeRecognition](../../)
61+
* Library [Aspose.BarCode for C++](../../../)

‎english/cpp/aspose.barcode.barcoderecognition/australiapostsettings/_index.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Aspose::BarCode::BarCodeRecognition::AustraliaPostSettings class
3+
linktitle: AustraliaPostSettings
4+
second_title: Aspose.BarCode for C++ API Reference
5+
description: 'Aspose::BarCode::BarCodeRecognition::AustraliaPostSettings class. AustraliaPost decoding parameters. Contains parameters which make influence on recognized data of AustraliaPost symbology in C++.'
6+
type: docs
7+
weight: 200
8+
url: /cpp/aspose.barcode.barcoderecognition/australiapostsettings/
9+
---
10+
## AustraliaPostSettings class
11+
12+
13+
AustraliaPost decoding parameters. Contains parameters which make influence on recognized data of AustraliaPost symbology.
14+
15+
```cpp
16+
class AustraliaPostSettings : public System::Object
17+
```
18+
19+
## Methods
20+
21+
| Method | Description |
22+
| --- | --- |
23+
| [get_CustomerInformationDecoder](./get_customerinformationdecoder/)() | Public interface for Customer Information Field decoding which is used in AustraliaPost symbology. |
24+
| [get_CustomerInformationInterpretingType](./get_customerinformationinterpretingtype/)() | Gets the Interpreting Type for the Customer Information of AustralianPost BarCode.Default is [CustomerInformationInterpretingType.Other](../../aspose.barcode/customerinformationinterpretingtype/). |
25+
| [get_IgnoreEndingFillingPatternsForCTable](./get_ignoreendingfillingpatternsforctable/)() | The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequnce "333" of filling paterns is decoded as letter "z". |
26+
| [set_CustomerInformationDecoder](./set_customerinformationdecoder/)(System::SharedPtr\<AustraliaPostCustomerInformationDecoder\>) | Public interface for Customer Information Field decoding which is used in AustraliaPost symbology. |
27+
| [set_CustomerInformationInterpretingType](./set_customerinformationinterpretingtype/)(Aspose::BarCode::CustomerInformationInterpretingType) | Sets the Interpreting Type for the Customer Information of AustralianPost BarCode.Default is [CustomerInformationInterpretingType.Other](../../aspose.barcode/customerinformationinterpretingtype/). |
28+
| [set_IgnoreEndingFillingPatternsForCTable](./set_ignoreendingfillingpatternsforctable/)(bool) | The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequnce "333" of filling paterns is decoded as letter "z". |
29+
## See Also
30+
31+
* Namespace [Aspose::BarCode::BarCodeRecognition](../)
32+
* Library [Aspose.BarCode for C++](../../)

‎english/cpp/aspose.barcode.barcoderecognition/australiapostsettings/get_customerinformationdecoder/_index.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Aspose::BarCode::BarCodeRecognition::AustraliaPostSettings::get_CustomerInformationDecoder method
3+
linktitle: get_CustomerInformationDecoder
4+
second_title: Aspose.BarCode for C++ API Reference
5+
description: 'Aspose::BarCode::BarCodeRecognition::AustraliaPostSettings::get_CustomerInformationDecoder method. Public interface for Customer Information Field decoding which is used in AustraliaPost symbology in C++.'
6+
type: docs
7+
weight: 100
8+
url: /cpp/aspose.barcode.barcoderecognition/australiapostsettings/get_customerinformationdecoder/
9+
---
10+
## AustraliaPostSettings::get_CustomerInformationDecoder method
11+
12+
13+
Public interface for Customer Information Field decoding which is used in AustraliaPost symbology.
14+
15+
```cpp
16+
System::SharedPtr<AustraliaPostCustomerInformationDecoder> Aspose::BarCode::BarCodeRecognition::AustraliaPostSettings::get_CustomerInformationDecoder()
17+
```
18+
19+
## Remarks
20+
21+
22+
Public interface for Customer Information Field decoding which is used in AustraliaPost symbology.
23+
24+
25+
26+
## See Also
27+
28+
* Class [AustraliaPostCustomerInformationDecoder](../../australiapostcustomerinformationdecoder/)
29+
* Class [AustraliaPostSettings](../)
30+
* Namespace [Aspose::BarCode::BarCodeRecognition](../../)
31+
* Library [Aspose.BarCode for C++](../../../)

‎english/cpp/aspose.barcode.barcoderecognition/australiapostsettings/get_customerinformationinterpretingtype/_index.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Aspose::BarCode::BarCodeRecognition::AustraliaPostSettings::get_CustomerInformationInterpretingType method
3+
linktitle: get_CustomerInformationInterpretingType
4+
second_title: Aspose.BarCode for C++ API Reference
5+
description: 'Aspose::BarCode::BarCodeRecognition::AustraliaPostSettings::get_CustomerInformationInterpretingType method. Gets the Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other in C++.'
6+
type: docs
7+
weight: 200
8+
url: /cpp/aspose.barcode.barcoderecognition/australiapostsettings/get_customerinformationinterpretingtype/
9+
---
10+
## AustraliaPostSettings::get_CustomerInformationInterpretingType method
11+
12+
13+
Gets the Interpreting Type for the Customer Information of AustralianPost BarCode.Default is [CustomerInformationInterpretingType.Other](../../../aspose.barcode/customerinformationinterpretingtype/).
14+
15+
```cpp
16+
Aspose::BarCode::CustomerInformationInterpretingType Aspose::BarCode::BarCodeRecognition::AustraliaPostSettings::get_CustomerInformationInterpretingType()
17+
```
18+
19+
## Remarks
20+
21+
22+
The interpreting type (CTable, NTable or Other) of customer information for AustralianPost [BarCode](../../../aspose.barcode/)
23+
24+
25+
26+
## See Also
27+
28+
* Enum [CustomerInformationInterpretingType](../../../aspose.barcode/customerinformationinterpretingtype/)
29+
* Class [AustraliaPostSettings](../)
30+
* Namespace [Aspose::BarCode::BarCodeRecognition](../../)
31+
* Library [Aspose.BarCode for C++](../../../)

‎english/cpp/aspose.barcode.barcoderecognition/australiapostsettings/get_ignoreendingfillingpatternsforctable/_index.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
title: Aspose::BarCode::BarCodeRecognition::AustraliaPostSettings::get_IgnoreEndingFillingPatternsForCTable method
3+
linktitle: get_IgnoreEndingFillingPatternsForCTable
4+
second_title: Aspose.BarCode for C++ API Reference
5+
description: 'Aspose::BarCode::BarCodeRecognition::AustraliaPostSettings::get_IgnoreEndingFillingPatternsForCTable method. The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequnce "333" of filling paterns is decoded as letter "z" in C++.'
6+
type: docs
7+
weight: 300
8+
url: /cpp/aspose.barcode.barcoderecognition/australiapostsettings/get_ignoreendingfillingpatternsforctable/
9+
---
10+
## AustraliaPostSettings::get_IgnoreEndingFillingPatternsForCTable method
11+
12+
13+
The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequnce "333" of filling paterns is decoded as letter "z".
14+
15+
```cpp
16+
bool Aspose::BarCode::BarCodeRecognition::AustraliaPostSettings::get_IgnoreEndingFillingPatternsForCTable()
17+
```
18+
19+
## Remarks
20+
21+
22+
The flag which force AustraliaPost decoder to ignore last filling patterns during CTable method decoding
23+
24+
This sample shows how to generate and recognize Australia Post barcode with CTable Interpreting Type and ignoring filling patterns.
25+
```cpp
26+
[C#]
27+
using (BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.AustraliaPost, "5912345678AB"))
28+
{
29+
generator.Parameters.Barcode.AustralianPost.AustralianPostEncodingTable = CustomerInformationInterpretingType.CTable;
30+
using (Bitmap image = generator.GenerateBarCodeImage())
31+
using (BarCodeReader reader = new BarCodeReader(image, DecodeType.AustraliaPost))
32+
{
33+
reader.BarcodeSettings.AustraliaPost.CustomerInformationInterpretingType = CustomerInformationInterpretingType.CTable;
34+
reader.BarcodeSettings.AustraliaPost.IgnoreEndingFillingPatternsForCTable = true;
35+
foreach (BarCodeResult result in reader.ReadBarCodes())
36+
{
37+
Console.WriteLine("BarCode Type: " + result.CodeType);
38+
Console.WriteLine("BarCode CodeText: " + result.CodeText);
39+
}
40+
}
41+
}
42+
[VB.NET]
43+
Using generator As New BarcodeGenerator(EncodeTypes.AustraliaPost, "5912345678AB")
44+
generator.Parameters.Barcode.AustralianPost.AustralianPostEncodingTable = CustomerInformationInterpretingType.CTable
45+
Using image As Bitmap = generator.GenerateBarCodeImage()
46+
Using reader As New BarCodeReader(image, DecodeType.AustraliaPost)
47+
reader.BarcodeSettings.AustraliaPost.CustomerInformationInterpretingType = CustomerInformationInterpretingType.CTable
48+
reader.BarcodeSettings.AustraliaPost.IgnoreEndingFillingPatternsForCTable = True
49+
For Each result As BarCodeResult In reader.ReadBarCodes()
50+
Console.WriteLine("BarCode Type: " + result.CodeTypeName)
51+
Console.WriteLine("BarCode CodeText: " + result.CodeText)
52+
Next
53+
End Using
54+
End Using
55+
End Using
56+
```
57+
58+
## See Also
59+
60+
* Class [AustraliaPostSettings](../)
61+
* Namespace [Aspose::BarCode::BarCodeRecognition](../../)
62+
* Library [Aspose.BarCode for C++](../../../)

‎english/cpp/aspose.barcode.barcoderecognition/australiapostsettings/set_customerinformationdecoder/_index.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Aspose::BarCode::BarCodeRecognition::AustraliaPostSettings::set_CustomerInformationDecoder method
3+
linktitle: set_CustomerInformationDecoder
4+
second_title: Aspose.BarCode for C++ API Reference
5+
description: 'Aspose::BarCode::BarCodeRecognition::AustraliaPostSettings::set_CustomerInformationDecoder method. Public interface for Customer Information Field decoding which is used in AustraliaPost symbology in C++.'
6+
type: docs
7+
weight: 400
8+
url: /cpp/aspose.barcode.barcoderecognition/australiapostsettings/set_customerinformationdecoder/
9+
---
10+
## AustraliaPostSettings::set_CustomerInformationDecoder method
11+
12+
13+
Public interface for Customer Information Field decoding which is used in AustraliaPost symbology.
14+
15+
```cpp
16+
void Aspose::BarCode::BarCodeRecognition::AustraliaPostSettings::set_CustomerInformationDecoder(System::SharedPtr<AustraliaPostCustomerInformationDecoder> value)
17+
```
18+
19+
## Remarks
20+
21+
22+
Public interface for Customer Information Field decoding which is used in AustraliaPost symbology.
23+
24+
25+
26+
## See Also
27+
28+
* Class [AustraliaPostCustomerInformationDecoder](../../australiapostcustomerinformationdecoder/)
29+
* Class [AustraliaPostSettings](../)
30+
* Namespace [Aspose::BarCode::BarCodeRecognition](../../)
31+
* Library [Aspose.BarCode for C++](../../../)

0 commit comments

Comments
 (0)