xref: /illumos-gate/usr/src/man/man3proc/Pcreate_error.3proc (revision 43051d2742bbe5911de73322064cb573b6aff975)
1*43051d27SRobert Mustacchi.\"
2*43051d27SRobert Mustacchi.\" This file and its contents are supplied under the terms of the
3*43051d27SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
4*43051d27SRobert Mustacchi.\" You may only use this file in accordance with the terms of version
5*43051d27SRobert Mustacchi.\" 1.0 of the CDDL.
6*43051d27SRobert Mustacchi.\"
7*43051d27SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
8*43051d27SRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
9*43051d27SRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
10*43051d27SRobert Mustacchi.\"
11*43051d27SRobert Mustacchi.\"
12*43051d27SRobert Mustacchi.\" Copyright 2015 Joyent, Inc.
13*43051d27SRobert Mustacchi.\"
14*43051d27SRobert Mustacchi.Dd May 11, 2016
15*43051d27SRobert Mustacchi.Dt PCREATE_ERROR 3PROC
16*43051d27SRobert Mustacchi.Os
17*43051d27SRobert Mustacchi.Sh NAME
18*43051d27SRobert Mustacchi.Nm Pcreate_error
19*43051d27SRobert Mustacchi.Nd get Pcreate, Pxcreate error message string
20*43051d27SRobert Mustacchi.Sh SYNOPSIS
21*43051d27SRobert Mustacchi.Lb libproc
22*43051d27SRobert Mustacchi.In libproc.h
23*43051d27SRobert Mustacchi.Ft "const char *"
24*43051d27SRobert Mustacchi.Fo Pcreate_error
25*43051d27SRobert Mustacchi.Fa "int error"
26*43051d27SRobert Mustacchi.Fc
27*43051d27SRobert Mustacchi.Sh DESCRIPTION
28*43051d27SRobert MustacchiThe
29*43051d27SRobert Mustacchi.Fn Pcreate_error
30*43051d27SRobert Mustacchifunction returns a pointer to a human-readable character string
31*43051d27SRobert Mustacchidescribing the error that occurred. The
32*43051d27SRobert Mustacchi.Fn Pcreate_error
33*43051d27SRobert Mustacchifunction translates errors produced by the
34*43051d27SRobert Mustacchi.Xr Pcreate 3PROC
35*43051d27SRobert Mustacchiand
36*43051d27SRobert Mustacchi.Xr Pxcreate 3PROC
37*43051d27SRobert Mustacchifunctions only (passed as the
38*43051d27SRobert Mustacchi.Fa perr
39*43051d27SRobert Mustacchiargument).
40*43051d27SRobert Mustacchi.Sh RETURN VALUES
41*43051d27SRobert MustacchiThe
42*43051d27SRobert Mustacchi.Fn Pcreate_error
43*43051d27SRobert Mustacchifunction always returns a pointer to a character string that describes
44*43051d27SRobert Mustacchithe error that occurred, even if it is an unknown error.
45*43051d27SRobert Mustacchi.Sh INTERFACE STABILITY
46*43051d27SRobert Mustacchi.Sy Uncommitted
47*43051d27SRobert Mustacchi.Sh MT-LEVEL
48*43051d27SRobert Mustacchi.Sy MT-Safe
49*43051d27SRobert Mustacchi.Sh SEE ALSO
50*43051d27SRobert Mustacchi.Xr libproc 3LIB ,
51*43051d27SRobert Mustacchi.Xr Pcreate 3PROC ,
52*43051d27SRobert Mustacchi.Xr Pxcreate 3PROC
53