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 LIBRARY
  21 .Lb libproc
  22 .Sh SYNOPSIS
  23 .In libproc.h
  24 .Ft "const char *"
  25 .Fo Pcreate_error
  26 .Fa "int error"
  27 .Fc
  28 .Sh DESCRIPTION
  29 The
  30 .Fn Pcreate_error
  31 function returns a pointer to a human-readable character string
  32 describing the error that occurred.
  33 The
  34 .Fn Pcreate_error
  35 function translates errors produced by the
  36 .Xr Pcreate 3PROC
  37 and
  38 .Xr Pxcreate 3PROC
  39 functions only (passed as the
  40 .Fa perr
  41 argument).
  42 .Sh RETURN VALUES
  43 The
  44 .Fn Pcreate_error
  45 function always returns a pointer to a character string that describes
  46 the error that occurred, even if it is an unknown error.
  47 .Sh INTERFACE STABILITY
  48 .Sy Uncommitted
  49 .Sh MT-LEVEL
  50 .Sy MT-Safe
  51 .Sh SEE ALSO
  52 .Xr libproc 3LIB ,
  53 .Xr Pcreate 3PROC ,
  54 .Xr Pxcreate 3PROC