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 November 27, 2023 15.Dt LGRAB_ERROR 3PROC 16.Os 17.Sh NAME 18.Nm Lgrab_error 19.Nd get Lgrab error message string 20.Sh LIBRARY 21.Lb libproc 22.Sh SYNOPSIS 23.In libproc.h 24.Ft "const char *" 25.Fo Lgrab_error 26.Fa "int error" 27.Fc 28.Sh DESCRIPTION 29The 30.Fn Lgrab_error 31function returns a pointer to a human-readable character string 32describing the error that occurred. 33The 34.Fn Lgrab_error 35function only knows how to translate error codes that were stored in 36the third argument 37.Pq Fa perr 38of a call to 39.Xr Lgrab 3PROC . 40.Sh RETURN VALUES 41The 42.Fn Lgrab_error 43function always returns a pointer to a character string describing the 44error that occurred, even if it is an unknown error. 45.Sh INTERFACE STABILITY 46.Sy Uncommitted 47.Sh MT-LEVEL 48.Sy MT-Safe 49.Sh SEE ALSO 50.Xr libproc 3LIB , 51.Xr Lgrab 3PROC 52