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