Template Functions > DumpTemplate

After the values for all required Fields have been set, the whole template is dumped into the current and all following pages of the VPE document with this method.

method integer VPE.DumpTemplate(

TVPETemplate objTemplate

)

TVPETemplate objTemplate

the Template Object that shall be dumped

Returns:

Error Status, this is either VERR_OK if no error occurred, or any of the VERR_xyz values.

Remarks:

The DumpTemplate()-methods do not make any differences between the AutoBreakMode AUTO_BREAK_ON and AUTO_BREAK_FULL, i.e. objects are always inserted into the current VPE Document with the given left and right coordinates if one of either modes is set.

In case of an error, LastError is set.

A template may only be dumped into the VPE document into which it was loaded, otherwise LastError will be set to VERR_TPL_OWNERSHIP.

[Interactive Edition only]

A template which contains Controls can only be dumped once into a VPE Document. If you wish to dump it more than once into one and the same VPE Document, you need to load the same template as often into memory as you want to dump it. Otherwise DumpTemplate() will return the error code VERR_TPL_PAGE_ALREADY_DUMPED. A template which does not contain Controls can be dumped as often into one and the same VPE Document as you like.