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 SYNOPSIS 21.Lb libproc 22.In libproc.h 23.Ft "const char *" 24.Fo Pgrab_error 25.Fa "int error" 26.Fc 27.Sh DESCRIPTION 28The 29.Fn Pgrab_error 30function returns a pointer to a human-readable character string 31describing the error that occurred. 32This function only knows how to translate errors that are stored in 33.Fa perr 34during a failed call to 35.Xr Pgrab 3PROC , 36.Xr Pfgrab_core 3PROC, 37.Xr Pgrab_core 3PROC , 38or 39.Xr Pgrab_file 3PROC . 40.Sh RETURN VALUES 41The 42.Fn Pgrab_error 43function always returns a pointer to a character string that describes 44the error 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 Pgrab 3PROC , 52.Xr Pgrab_core 3PROC , 53.Xr Pgrab_file 3PROC 54