man pages section 3: Basic Library Functions

Exit Print View

Updated: July 2014
 
 

setlabel(3C)

Name

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

Synopsis

#include <pfmt.h>

int setlabel(const char *label);

Description

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

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

No label is defined before setlabel() is called. The label should be set once at the beginning of a utility and remain constant. A null pointer or an empty string passed as argument will reset the definition of the label.

RETURN VALUE

RETURN VALUE

Upon successful completion, setlabel() returns 0; otherwise, it returns a non-zero value.

Examples

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

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
MT-Level
MT-Safe

See Also

getopt(3C), lfmt(3C), pfmt(3C), attributes(5)