xref: /illumos-gate/usr/src/man/man3dlpi/dlpi_strerror.3dlpi (revision 6e6545bfaed3bab9ce836ee82d1abd8f2edba89a)
te
Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
DLPI_STRERROR 3DLPI "Aug 22, 2007"
NAME
dlpi_strerror - get DLPI error message
SYNOPSIS

cc [ flag... ] file... -ldlpi [ library... ]
#include <libdlpi.h>

const char *dlpi_strerror(int err);
DESCRIPTION

The dlpi_strerror() function maps the error code in err into an error message string and returns a pointer to that string.

If err is DL_SYSERR, a string that describes the current value of errno is returned. Otherwise, if err corresponds to an error code listed in <libdlpi.h> or <sys/dlpi.h>, a string which describes that error is returned.

The string is not dynamically allocated and must not be freed by the caller.

RETURN VALUES

Upon success, the function returns a pointer to the error message string. If the error code is unknown, the string "Unknown DLPI error" is returned.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level Safe
SEE ALSO

libdlpi(3LIB), attributes(5)