L_PdfCompInsertSegments

Summary

Applies the segments specified in pSegmentInfo to the specified bitmap, then compresses and inserts the resulting image into the PDF file in memory.

Syntax

#include "l_bitmap.h"
#include "lpdfComp.h"

L_LCMRC_API L_INT L_PdfCompInsertSegments(hDocHandle, pBitmap, uSegmentCnt, pSegmentInfo, bIsThereBackGround, rgbBackGroundColor);

Parameters

LCPDF_HANDLE hDocHandle

Handle to an existing PDF document. This handle is obtained by calling the L_PdfCompInit function.

pBITMAPHANDLE pBitmap

Pointer to the bitmap handle that references the image to be inserted in the PDF file.

L_UINT uSegmentCnt

Number of elements in the pSegmentInfo parameter. It represents the number of segments that will be applied to pBitmap.

LPSEGMENTINFO pSegmentInfo

Pointer to the SEGMENTINFO structure that contains an array that has the information for each segment.

L_BOOL bIsThereBackGround

Flag that indicates whether to use the average background color to represent the background of the page in the PDF file. Possible values are:

COLORREF rgbBackGroundColor

Average background color. This parameter is ignored if bIsThereBackGround is FALSE.

Returns

Comments

To insert the bitmap using MRC segmentation, use L_PdfCompInsertMRC.

Required DLLs and Libraries

• LCMRC
• LCPPDF
• LCPENC
• LCZIB
• 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

• L_PdfCompInsertMRC
• L_PDFCompInsertNormal
• L_PDFCompSetCompression

Topics

• Creating a Compressed PDF File
• PDF Compressor Functions: Creating a File

Example

This example inserts an image to pdf document with using user Segments.

L_INT PdfCompInsertSegmentsExample(pBITMAPHANDLE   pBitmap, 
                                                   L_UINT          uSegmentCnt, 
                                                   LPSEGMENTINFO   pSegmentInfo, 
                                                   COLORREF        rgbBackGroundColor, 
                                                   L_BOOL          bIsThereBackGround) 
{ 
   L_INT          nRet;  
   LCPDF_HANDLE   hDocument; 
 
   nRet = L_PdfCompInit(&hDocument,NULL,NULL); 
   if(nRet != SUCCESS) 
   { 
      return nRet; 
   } 
 
   nRet = L_PdfCompInsertSegments( hDocument, pBitmap, uSegmentCnt, pSegmentInfo, bIsThereBackGround, rgbBackGroundColor); 
   if(nRet != SUCCESS) 
   { 
      L_PdfCompFree(hDocument); 
      return nRet; 
   } 
 
   nRet = L_PdfCompWrite (hDocument, MAKE_IMAGE_PATH(TEXT("Output.pdf"))); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   L_PdfCompFree (hDocument);  
   return SUCCESS; 
}