In This Topic ▼

DOCUMENTCREATEFILEOPTIONS

Summary

The DOCUMENTCREATEFILEOPTIONS structure specifies options used to create the output file.

Syntax

typedef struct _DOCUMENTCREATEFILEOPTIONS 
{ 
   L_UINT uStructSize; 
   L_TCHAR *pszFileName; 
   DOCWRTFORMAT Format; 
   L_VOID *pOptions; 
   L_SIZED Size; 
   L_DOUBLE DpiX; 
   L_DOUBLE DpiY; 
   L_UINT Flags; 
   L_INT FirstPageNumber; 
   L_INT LastPageNumber; 
} DOCUMENTCREATEFILEOPTIONS, * pDOCUMENTCREATEFILEOPTIONS;

Members

uStructSize

Size of the DOCUMENTCREATEFILEOPTIONS structure. This should be sizeof(DOCUMENTCREATEFILEOPTIONS). You must fill this member.

pszFileName

Pointer to the name of the output file. You must fill this member.

Format

Indicates the format of the output file. Currently, this must be set to DOCUMENTFORMAT_PDF. You must fill this member.

pOptions

Optional pointer to a structure containing options specific to the output file format. Currently, the only type of structure supported is DOCWRTPDFOPTIONS for PDF files. Pass NULL to specify default options.

Size

Optional structure indicating the desired output file size. If both Size.width and Size.height are 0, the size of the output file is the same as the size of the input file.

DpiX

Optional value indicating at which X resolution to load the source file. If 0, the file will be loaded at the default resolution (150).

DpiY

Optional value indicating at which Y resolution to load the source file. If 0, the file will be loaded at the default resolution (150).

Flags

Reserved for future use. Pass 0 for now.

FirstPageNumber

1-based index of the first page that should be loaded. If 1 or 0, the load will start with the first page.

LastPageNumber

1-based index of the last page that should be loaded. Set to 0 to select the last page in the source file.

Comments

pDOCUMENTCREATEFILEOPTIONS is a pointer to a DOCUMENTCREATEFILEOPTIONS structure.

Setting FirstPageNumber and LastPageNumber to 0 instructs L_LoadDoc to load all the pages in the source file. Setting FirstPageNumber to 2 and LastPageNumber to 4 instructs L_LoadDoc to create a file containing 3 pages, representing pages 2, 3 and 4 from the source file.

If FirstPageNumber and LastPageNumber are > 1, they must represent existing pages in the source file. If any of either FirstPageNumber or LastPageNumber are greater than the number of pages in the source file, L_LoadDoc will fail with ERROR_INV_PAGE_NUMBERS.