solaris Man Page: setlabel(3c)

Man Pages

Back to Software Index BORDER=0

setlabel(3C) manual page Table of Contents

Name

setlabel - define the label for pfmt() and lfmt().

MT-safe

#include <pfmt.h>

int setlabel(const char *label);

The routine setlabel() defines the label for messages produced in standard format by subsequent calls to pfmt() and lfmt().

label is a character string no more than 25 characters in length.

No label is defined before setlabel() is called. A NULL pointer or an empty string passed as argument will reset the definition of the label.

setlabel() returns 0 in case of success, non-zero otherwise.

The following code (without previous call to setlabel()):

    pfmt(stderr, MM_ERROR, "test:2:Cannot open file\n");
    setlabel("UX:test");
    pfmt(stderr, MM_ERROR, "test:2:Cannot open file\n");

will produce the following output:

    ERROR: Cannot open file
    UX:test: ERROR: Cannot open file

The label should be set once at the beginning of a utility and remain constant.