DspRichTextSave

Cicode Programming Reference > Cicode Function Categories > Display Functions Introduction > DspRichTextSave

DspRichTextSave

Saves the contents of the rich text object at animation point AN, to the file Filename.

Syntax

DspRichTextSave(AN, sFilename)

AN:

The reference AN for the rich text object.

sFilename:

The name under which the contents of the rich text object will be saved. This name needs to be enclosed within quotation marks "", and needs to include the destination path. For example "[Data]\saved.rtf".

Return Value

0 if successful, otherwise an error is returned.

Related Functions

DspRichText, PageRichTextFile, DspRichTextLoad, DspRichTextEdit

Example

// These lines show two different ways of saving the contents of

the rich text object (at AN 25) to file DayRep.rtf//

DspRichTextSave(25,"[Data]\DayRep.rtf");

DspRichTextSave(25,"c:\MyApplication\data\DayRep.rtf");