1.\" 2.\" This file and its contents are supplied under the terms of the 3.\" Common Development and Distribution License ("CDDL"), version 1.0. 4.\" You may only use this file in accordance with the terms of version 5.\" 1.0 of the CDDL. 6.\" 7.\" A full copy of the text of the CDDL should have accompanied this 8.\" source. A copy of the CDDL is also available via the Internet at 9.\" http://www.illumos.org/license/CDDL. 10.\" 11.\" 12.\" Copyright 2015 Joyent, Inc. 13.\" 14.Dd May 11, 2016 15.Dt LGRAB_ERROR 3PROC 16.Os 17.Sh NAME 18.Nm Lgrab_error 19.Nd get Lgrab error message string 20.Sh SYNOPSIS 21.Lb libproc 22.In libproc.h 23.Ft "const char *" 24.Fo Lgrab_error 25.Fa "int error" 26.Fc 27.Sh DESCRIPTION 28The 29.Fn Lgrab_error 30function returns a pointer to a human-readable character string 31describing the error that occurred. The 32.Fn Lgrab_error 33function only knows how to translate error codes that were stored in 34the third argument 35.Pf ( Fa perr Ns ) 36of a call to 37.Xr Lgrab 3PROC . 38.Sh RETURN VALUES 39The 40.Fn Lgrab_error 41function always returns a pointer to a character string describing the 42error that occurred, even if it is an unknown error. 43.Sh INTERFACE STABILITY 44.Sy Uncommitted 45.Sh MT-LEVEL 46.Sy MT-Safe 47.Sh SEE ALSO 48.Xr libproc 3LIB , 49.Xr Lgrab 3PROC 50