LBarCode::Write

Summary

Writes linear, PDF, PDF417, MicroPDF417, Data Matrix, QR, Aztec, Maxi and MicroQR barcode symbols over the bitmap.

Syntax

L_INT LBarCode::Write(pBarCodeData, ulFlags = 0, pBarColor = NULL, pBarCode1D =  NULL, pBarCodePDF = NULL, pBarCodeDM =  NULL, pBarCodeQR = NULL, pBarCodeAztec = NULL, pBarCodeMaxi = NULL, pBarCodeMicroQR = NULL, lprcSize = NULL);

Parameters

pBARCODEDATA pBarCodeData

Pointer to the BARCODEDATA structure that contains the barcode information to be written over the image.

L_UINT32 ulFlags

Flags that indicate the function behavior. You can combine values when appropriate, by using a bitwise OR ( | ). The following values are used only when you want to write Data Matrix or PDF barcodes. Pass 0 to use the default values, based on the type of barcode being written. Possible values are:

pBARCODECOLOR pBarColor

Pointer to the BARCODECOLOR structure that contains the color information to be written over the image. Pass NULL to write barcode using the default colors.

pBARCODE1D pBarCode1D

Pointer to the BARCODE1D structure that contains the information related to linear barcodes. Pass NULL to use the default or if you do not want to write a linear barcode.

pBARCODEWRITEPDF pBarCodePDF

Pointer to the BARCODEWRITEPDF structure that contains the information related to PDF417 and MicroPDF417 barcodes. Pass NULL to use the default or if you do not want to write a PDF or MicroPDF barcode.

pBARCODEWRITEDM pBarCodeDM

Pointer to the BARCODEWRITEDM structure that contains the information related to Data Matrix barcodes. Pass NULL to use the default or if you do not want to write a Data Matrix barcode. The members of this structure are useful when you need to split the information among several different barcodes.

pBARCODEWRITEQR pBarCodeQR

Pointer to the BARCODEWRITEQR structure that contains the information related to QR barcodes. Pass NULL to use the default or if you do not want to write a Data QR barcode.

pBARCODEWRITEAZTEC pBarCodeAztec

Pointer to the BARCODEWRITEAZTEC structure that contains the information related to Aztec barcodes. Pass NULL to use the default or if you do not want to write an Aztec barcode.

pBARCODEWRITEMAXI pBarCodeMaxi

Pointer to the BARCODEWRITEMAXI structure that contains the information related to Maxi barcodes. Pass NULL to use the default or if you do not want to write a Maxi barcode.

pBARCODEWRITEMICROQR pBarCodeMicroQR

Pointer to the BARCODEWRITEMICROQR structure that contains the information related to MicroQR barcodes. Pass NULL to use the default or if you do not want to write a MicroQR barcode.

LPRECT lprcSize

Pointer to the RECT structure to be updated with the barcode size before writing the barcode over the bitmap. If the user passes a valid pointer, then the function will calculate the size of the barcode and will update this parameter with the barcode size. Pass NULL to write the barcode.

Returns

Comments

While the LBarCode::Write function writes linear, PDF, MicroPDF, QR and Data Matrix barcodes.

The LBarCode::Write function will write the barcode symbol over the bitmap using the rectangle defined by the rcBarLocation member in pBarCodeData. However, if the bitmap has a region, this function will write the barcode using the region boundaries.

If the region is non-rectangular, the barcode will be written to the rectangle bounding the region and subsequently clipped to the given region. This might cause the resulting barcode to be unreadable.

If you set the ulFlags parameter to BARCODE_USECOLORS, then this function will use the pBarCodeColor parameter. Otherwise, the function will ignore it and use the default colors of black for bars and white for spaces.

Using colors does not apply for 1 bit per pixel images.

The BARCODE_USECOLORS and BARCODE_TRANSPARENT values are used with all barcode types.

NOTE: This function does not support BARCODE_1D_UCCEAN_128.

Linear barcodes are not supported in UNICODE.

This function replaces LBarCode::WriteExt.

For a table containing information useful when writing 1D barcode data, refer to Writing Linear 1D Barcodes.

Required DLLs and Libraries

• LTBAR
• For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions

• LBarCode::LBarCode
• LBarCode::Read
• Class Members

Topics

• Programming with LEADTOOLS Barcode
• Barcode Function Functions: Writing BarCodes

Example

For a complete sample code, refer to the BarCode demo.

L_INT LBarCode_WriteExample(LBitmapBase *pLeadBitmap)  
 
{ 
   L_INT nRet; 
 
   LBase::LoadLibraries(LT_ALL_LEADLIB);//make sure all libraries are loaded 
 
   LBarCode MyBarCode(pLeadBitmap);  
 
   if (MyBarCode.IsValid()) 
 
   { 
 
      BARCODEDATA BarCodeData;  
 
      BARCODE1D Bar1D;  
 
      BARCODECOLOR BarColor;  
 
      memset(&BarCodeData, 0, sizeof(BARCODEDATA));  
 
      memset(&Bar1D, 0, sizeof(BARCODE1D));  
 
      memset(&BarColor, 0, sizeof(BARCODECOLOR));  
 
      BarCodeData.uStructSize = sizeof(BARCODEDATA);  
 
      Bar1D.uStructSize = sizeof(BARCODE1D);  
 
      BarColor.uStructSize = sizeof(BARCODECOLOR);  
 
      BarCodeData.rcBarLocation.left = 50; // 1/2 inch 
 
      BarCodeData.rcBarLocation.top = 50; // 1/2 inch 
 
      BarCodeData.rcBarLocation.right = 200; // 2.0 inch (width = 1.5 inch)  
 
      BarCodeData.rcBarLocation.bottom = 100; // 1 inch (height = ½ inch)  
 
      BarCodeData.nUnits = BARCODE_SCANLINES_PER_PIXELS;  
 
      BarCodeData.ulType = BARCODE_1D_EAN_13;  
 
      BarCodeData.pszBarCodeData = "123456789012";    
 
      BarCodeData.nSizeofBarCodeData = (L_INT) strlen(BarCodeData.pszBarCodeData);  
 
      Bar1D.bErrorCheck = TRUE;  
 
      Bar1D.bOutShowText= TRUE;  
 
      BarColor.dwColorBar = RGB(0, 0, 255); 
 
      BarColor.dwColorSpace = RGB(255, 0, 0);  
 
      nRet = MyBarCode.Write(&BarCodeData, BARCODE_USECOLORS, &BarColor, &Bar1D, NULL, NULL, NULL, NULL);  
      if(nRet != SUCCESS) 
         return nRet; 
   } 
   else 
   { 
      return FAILURE; 
   } 
 
   return SUCCESS; 
}