Sets a log file header.
INKReturnCode INKTextLogObjectHeaderSet (INKTextLogObject the_object, const char *header)
INKTextLogObject
the_object
is the log object for which you want to set the
header.
const char *header
is a log file
header.
A header for a log object is the banner (a text line)
printed at the top of the log file. This API must be
used once the object is created (using
INKTextLogObjectCreate
) and before writing
into logs (using INKTextLogObjectWrite
). By
default, a null header (empty line) is used.
INK_SUCCESS
if the API is called
successfully.
INK_ERROR
if an error occurs while calling
the API or if an argument is invalid.