share/man/man3proc/Lgrab_error.3proc

   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
  28 The
  29 .Fn Lgrab_error
  30 function returns a pointer to a human-readable character string
  31 describing the error that occurred.
  32 The
  33 .Fn Lgrab_error
  34 function only knows how to translate error codes that were stored in
  35 the third argument
  36 .Pf ( Fa perr Ns )
  37 of a call to
  38 .Xr Lgrab 3PROC .
  39 .Sh RETURN VALUES
  40 The
  41 .Fn Lgrab_error
  42 function always returns a pointer to a character string describing the
  43 error that occurred, even if it is an unknown error.
  44 .Sh INTERFACE STABILITY
  45 .Sy Uncommitted
  46 .Sh MT-LEVEL
  47 .Sy MT-Safe
  48 .Sh SEE ALSO
  49 .Xr libproc 3LIB ,
  50 .Xr Lgrab 3PROC