Index

C/C++ Functions

pdDocAppendFromStream

DT_SLONG pdDocAppendFromStream(DT_PDDOC power_doc, DT_SLONG page_off, DT_SLONG x_off, DT_SLONG y_off, const DT_STREAM_DESC* sd)

Short Description: Append document from stream

The pdDocAppendFromStream function appends a Power Engine document stored as a file to the master Power Engine document specified by the document instance power_doc. The file must be in the native uncompressed PowerDoc format.

Parameters

ParameterDescription

power_doc

Handle of the master Power Engine document.

page_off

A page offset of the Power Engine document to be appended.

x_off

A horizontal image offset, in document units, of the Power Engine document to be appended.

y_off

A vertical image offset, in document units, of the Power Engine document to be appended.

sd

A valid pointer to the DT_STREAM_DESC structure which supplies the location of the file containing the Power Engine document to be appended. The file must be in the native uncompressed PowerDoc format. Native PowerDoc files are usually recognized by their .pdc file extension.

Return Value

If the function was successful, the return value is 1. Otherwise, the function returns a negative number.

Comments

The page_off parameter represents a page offset of the document to be appended. For example, page_off = 1 indicates that all page values in the Power Engine document power_doc2 will be increased by 1 before the are appended to the master document power_doc. Similarly, page_off = 0 indicates that the page values will remain unchanged.

The x_off parameter represents a horizontal image offset, in document units, of the document to be appended. For example, x_off = 100 indicates that all image X coordinates in the Power Engine document power_doc2 will be increased by 100 document units before the document is appended to the master document power_doc. Similarly, x_off = 0 indicates that the image X coordinates will remain unchanged.

The y_off parameter represents a vertical image offset, in document units, of the document to be appended. For example, y_off = 100 indicates that all image Y coordinates in the Power Engine document power_doc2 will be increased by 100 document units before the document is appended to the master document power_doc. Similarly, y_off = 0 indicates that the image Y coordinates will remain unchanged.

Related Functions

pdDocAppend
pdDocSaveToStream

Note 1

See How To Use D-Type Streams And Stream Macros.

Note 2

See our notes regarding file based streams.

 

Index