share/man/man3proc/Pcreate_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 PCREATE_ERROR 3PROC
  16 .Os
  17 .Sh NAME
  18 .Nm Pcreate_error
  19 .Nd get Pcreate, Pxcreate error message string
  20 .Sh SYNOPSIS
  21 .Lb libproc
  22 .In libproc.h
  23 .Ft "const char *"
  24 .Fo Pcreate_error
  25 .Fa "int error"
  26 .Fc
  27 .Sh DESCRIPTION
  28 The
  29 .Fn Pcreate_error
  30 function returns a pointer to a human-readable character string
  31 describing the error that occurred.
  32 The
  33 .Fn Pcreate_error
  34 function translates errors produced by the
  35 .Xr Pcreate 3PROC
  36 and
  37 .Xr Pxcreate 3PROC
  38 functions only (passed as the
  39 .Fa perr
  40 argument).
  41 .Sh RETURN VALUES
  42 The
  43 .Fn Pcreate_error
  44 function always returns a pointer to a character string that describes
  45 the 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 Pcreate 3PROC ,
  53 .Xr Pxcreate 3PROC