xref: /illumos-gate/usr/src/man/man3proc/Pcreate_error.3proc (revision 43051d2742bbe5911de73322064cb573b6aff975)
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
28The
29.Fn Pcreate_error
30function returns a pointer to a human-readable character string
31describing the error that occurred. The
32.Fn Pcreate_error
33function translates errors produced by the
34.Xr Pcreate 3PROC
35and
36.Xr Pxcreate 3PROC
37functions only (passed as the
38.Fa perr
39argument).
40.Sh RETURN VALUES
41The
42.Fn Pcreate_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 Pcreate 3PROC ,
52.Xr Pxcreate 3PROC
53