DLI Implementation and Reference Guide - Datalogics

A.10 DLI Reference Guide
dlpdfcontentcomment (DLPDFCONTENT
*Content, char *Comment)
Return Value: void
Concepts and Facilities: Guide to the DL Pager Composition System
Description
Parameters
Return Value
This method will insert the specified text string
as a comment, in the order provided, into the
content elements.
• DLPDFCONTENT *Content: Represents the
content element. These structures are
destroyed when associated with a page or
form, and pointers to them should not be
used after that time.
• char *Comment: A text string
void
Exceptions
Header
dli.h
Related Methods
Availability
All DLI-supported platforms.
Technical Notes
1 The comment string will always be placed on a separate line, beginning with a
percent sign (“%”) provided by DLI to mark it as a comment.
2 The comment text must not contain a new line character, unless you provide a
percent sign immediately following it. (DLI provides only the initial percent sign
for each comment. Follow-on new lines within the comment text must contain
their own starting percent sign for each comment line of output.)
3 The content element must be valid: the comment pointer must point at a valid non-
NULL, non-zero length string.