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