VpeWriteDoc

<< Click to Display Table of Contents >>

Navigation:  Management Functions >

VpeWriteDoc

Previous pageReturn to chapter overviewNext page

Writes the currently open document to an external file.

Depending on the file suffix, the file is written to the following format:

.vpe – Native VPE document file format

.pdf – PDF file format

.htm or .html – HTML file format (requires Professional Edition or higher)

.xml – XML file format (requires Professional Edition or higher)

.odt – Open Document Text file format (requires Professional Edition or higher)

 

For details about creating and using VPE document files, please see the "Programmer's Manual", chapter "Programming Techniques", subchapter "VPE Document Files".

For details about creating PDF files, please see the "Programmer's Manual", chapter "The PDF Export Module".

For details about creating HTML files, please see the "Programmer's Manual", chapter "The HTML Export Module".

int VpeWriteDoc(

VpeHandle hDoc,

LPCSTR file_name

)

VpeHandle hDoc

Document Handle

LPCSTR file_name

the path and filename

Returns:

Value

Description

True

Success

False

Failure

Remarks:

In case of an error, LastError is set.

Depending on the setting of the property DocExportType, you can instruct VPE to write the file to a desired file format (VPE, PDF or HTML), regardless of the supplied file name's suffix.

The property Compression controls, whether a written document (VPE or PDF file format) is compressed.

 

Protection

VPE Document files can be read, edited and saved using our visual designer dycodoc.

If you want to protect your files from being edited, use the property EditProtection.