Index

C/C++ Functions

txTextIni

DT_SLONG txTextIni(DT_TXDOC* text_doc)

Short Description: Create and initialize empty text document

This function creates a new empty text document.

Parameters

ParameterDescription

text_doc

Pointer to the handle that will represent the newly created text document instance.

Return Value

If the new text document was created successfully, the return value will be 1. Otherwise, the function returns 0 and text_doc holds DV_NULL.

Comments

An application can call txTextIni multiple times and create as many empty text documents as necessary. When this function is called, each text document is created dynamically and must be destroyed by calling the txTextExt function.

After a successful call to txTextIni, applications will typically want to build some Unicode text in the newly created document by calling one of the following functions: txTextMakeViaStream, txTextMakeViaBuffer, txTextMakeViaPowerDoc. Alternatively, it is possible to execute both steps by a single call to one of the following convenience functions: txTextIniViaStream, txTextIniViaBuffer, txTextIniViaPowerDoc.

Related Functions

txTextIniViaStream, txTextIniViaBuffer, txTextIniViaPowerDoc
txTextMakeViaStream, txTextMakeViaBuffer, txTextMakeViaPowerDoc
txTextExt

 

Index