Index

C/C++ Functions

txTextMakeViaPowerDoc

DT_SLONG txTextMakeViaPowerDoc(DT_TXDOC text_doc, DT_PDDOC power_doc)

Short Description: Make text document - via PowerDoc

The txTextMakeViaPowerDoc function builds a Unicode text document from a Power Engine document (i.e. a document created using D-Type Power Engine and its API functions). However, this function does not perform any Unicode text algorithms on the text in the source Power Engine document (e.g. Unicode's implicit bidirectional reordering algorithm) and does not auto-detect Unicode scripts. The function simply accepts the text as supplied and assumes that any required Unicode text processing is already done in the supplied Power Engine document.

This function must be called once per text document instance, and only after a successful call to txTextIni. Applications that wish to rebuild their Unicode text using this function must first destroy the existing text document instance by calling txTextExt and then create a new one by calling txTextIni.

Parameters

ParameterDescription

text_doc

Handle of the associated text document instance.

power_doc

Handle of the previously created Power Engine document.

Return Value

If the Unicode text document was built successfully, the return value will be a non-negative integer. Otherwise, the function returns -1.

Comments

Power Engine documents that have malformed text objects may not be usable as Unicode text documents. Thus, D-Type Unicode Text Module may not be able to properly operate on such documents and its API functions may fail to generate any useful and/or expected results. The presence of other PowerDoc objects (e.g. bitmap images, patterns, gradients, vector based objects etc.) in the supplied Power Engine document is permitted. These objects will be retained in the Unicode text document.

For information on how to create valid Power Engine documents and valid text objects, see Guidelines For Creating PowerDoc Objects.

For other comments, see the comments section of the txTextMakeViaStream function.

Related Functions

txTextIniViaPowerDoc
txTextMakeViaStream, txTextMakeViaBuffer

 

Index