L_DocWriterInit - Raster Imaging C API Help

L_DocWriterInit

#include "l_bitmap.h"

L_LTDOCWRT_API L_INT EXT_FUNCTION L_DocWriterInit(phDocument, pszFileName, Format, pDocOptions, pfnStatusCallback, pUserData)

DOCUMENTWRITER_HANDLE * phDocument; pointer to the PDF document handle
L_WCHAR * pszFileName; name and path to the output file
DOCWRTFORMAT Format; file format for output file
L_VOID* pDocOptions; pointer to a Document Options structure
STATUSCALLBACK pfnStatusCallback; optional callback function
L_VOID * pUserData; pointer to user data

Initializes the Document Writer to create a document file.

Parameter Description
phDocument Pointer to the document handle that references the document file to create.
pszFileName Character string containing the name and path to the file to save (output file).
Format Format of the output file. Possible values are:
  Value Meaning
  DOCUMENTFORMAT_LTD [0] LEAD Temporary Document (LTD)
  DOCUMENTFORMAT_PDF [1] Portable Document format (PDF)
  DOCUMENTFORMAT_DOC [2] MS-Word document format (Doc)
  DOCUMENTFORMAT_RTF [3] Rich Text document format (RTF)
  DOCUMENTFORMAT_HTM [4] HyperText Markup Language document format (html)
  DOCUMENTFORMAT_TXT [5] Text file format (Txt)
  DOCUMENTFORMAT_EMF [6] Enhanced metafile format (EMF)
  DOCUMENTFORMAT_XPS [7] Microsoft XML Paper Specification format (XPS)
  DOCUMENTFORMAT_DOCX [8] Microsoft Word Document Format (docx)
  DOCUMENTFORMAT_XLS [9] MS-Excel document format (Xls)
pDocOptions Pointer to a Document Object structure. Possible values are:
  DOCWRTLTDOPTIONS /*LEAD format options*/
  DOCWRTEMFOPTIONS /*EMF format options*/
  DOCWRTTXTOPTIONS /*Text format options*/
  DOCWRTPDFOPTIONS /*PDF format options*/
  DOCWRTDOCOPTIONS /*Doc format options*/
  DOCWRTRTFOPTIONS /*RTF format options*/
  DOCWRTHTMOPTIONS /*Html format options*/
  DOCWRTXPSOPTIONS /*XPS format options*/
  DOCWRTDOCXOPTIONS /*DocX format options */
  DOCWRTXLSOPTIONS /*Microsoft Excel 97-2003 Spreadsheet Format (XLS)*/
pfnStatusCallback Pointer to an optional callback function used to follow the job's progress.
  If you do not provide a callback function, use NULL as the value of this parameter.
  If you do provide a callback function, use the function pointer as the value of this parameter.
pUserData Pointer that you can use to pass one or more additional parameters that the callback function needs.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

Call L_DocWriterInit before calling any other Document Writer functions.

This function also sets the progress callback function.

Required DLLs and Libraries

LtDocWrt_u.dll, LtDocWrt_x.dll
LTDocWrtEmf_u.dll, LTDocWrtEmf_x.dll
LTDocWrtTtf_u.dll, LTDocWrtTtf_x.dll
LTDocWrtPdf_u.dll, LTDocWrtPdf_x.dll
LTDocWrtDoc_u.dll, LTDocWrtDoc_x.dll
LTDocWrtRtf_u.dll, LTDocWrtRtf_x.dll
LTDocWrtHtm_u.dll, LTDocWrtHtm_x.dll
LTDocWrtTxt_u.dll, LTDocWrtTxt_x.dll
LTDocWrtXls_u.dll, LTDocWrtXls_x.dll
LTDocWrtDocx_u.dll, LTDocWrtDocx_x.dll
LTDocWrtXps_u.dll, LTDocWrtXps_x.dll
LtFil_u.dll, LtFil_x.dll
LfJb2_u.dll, LfJb2_x.dll
Lfcmp_u.dll, Lfcmp_x.dll
Lftif_u.dll, Lftif_x.dll
Lfraw_u.dll, Lfraw_x.dll
Lfbmp_u.dll, Lfbmp_x.dll
Lfpng_u.dll, Lfpng_x.dll
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Functions:

L_DocWriterAddPage, L_DocWriterFinish

Topics:

Creating Documents Having Different File Formats

 

Raster Image Functions: Document Writers

Example

This example adds an emf page to a black html page created.

L_INT L_DocWriterInitExample(L_VOID) 
{ 
   DOCWRTEMFPAGE Page; 
   L_INT nRet=0; 
   DOCWRTHTMOPTIONS html; 
   DOCUMENTWRITER_HANDLE hDocument; 
       
   memset(&html, 0, sizeof(DOCWRTHTMOPTIONS)); 
   memset(&Page, 0, sizeof(DOCWRTEMFPAGE)); 
    
   html.Options.uStructSize = sizeof(html); 
   html.Type = DOCWRTHTMTYPE_IECOMPATIBLE; 
   html.FontEmbed = DOCWRTFONTEMBED_ALL; 
   html.bUseBackgroundColor = TRUE; 
   html.rgbBackground = RGB(0x00, 0x00, 0x00); 
 
   nRet = L_DocWriterInit( &hDocument,  
                           MAKE_IMAGE_PATH(TEXT("Output.html")),  
                           DOCUMENTFORMAT_HTM,  
                           &html,  
                           NULL,  
                           NULL ); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   Page.hEmf = GetEnhMetaFile(MAKE_IMAGE_PATH(TEXT("Ocr1.emf"))); 
 
   nRet = L_DocWriterAddPage( hDocument, DOCWRTPAGETYPE_EMF, (L_VOID*)&Page); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   nRet = L_DocWriterFinish( hDocument ); 
   if(nRet != SUCCESS) 
      return nRet; 
 
   return SUCCESS; 
} 

Help Version 20.0.2018.7.30
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Raster Imaging C API Help