Requesting Information

Format Status Report

lgo_FormatStatusReport()

Print a status report to a user supplied buffer.

Syntax
#include "laygo.h"

LResult lgo_FormatStatusReport
    (
        LStatusReport     report,
        LMessage          newline,
        LMessageBuffer    buffer,
        LBufferSize       size
    );
reportreport to format
newlinenewline string
bufferoutput for formatted report
sizesize of buffer in bytes
Description

lgo_FormatStatusReport() prints a status report to a user supplied buffer.

Return Values

If successful, lgo_FormatStatusReport() returns the number of bytes written to buffer. The number of bytes written includes the terminating NUL. Otherwise, it returns a negative value indicating the reason it failed. Possible unsuccessful return values are:

See Also

lgo_FormatStatisticsTable()
lgo_PrintStatisticsTable()
lgo_PrintStatusReport()

Example
LResult    result;

if ((result = lgo_FormatStatusReport(report, NULL, buffer, size)) > 0)
{
    fputs(buffer, stdout);
}