xref: /illumos-gate/usr/src/man/man3proc/Pcreate_error.3proc (revision 72d3dbb9ab4481606cb93caca98ba3b3a8eb6ce2)
143051d27SRobert Mustacchi.\"
243051d27SRobert Mustacchi.\" This file and its contents are supplied under the terms of the
343051d27SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
443051d27SRobert Mustacchi.\" You may only use this file in accordance with the terms of version
543051d27SRobert Mustacchi.\" 1.0 of the CDDL.
643051d27SRobert Mustacchi.\"
743051d27SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
843051d27SRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
943051d27SRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
1043051d27SRobert Mustacchi.\"
1143051d27SRobert Mustacchi.\"
1243051d27SRobert Mustacchi.\" Copyright 2015 Joyent, Inc.
1343051d27SRobert Mustacchi.\"
1443051d27SRobert Mustacchi.Dd May 11, 2016
1543051d27SRobert Mustacchi.Dt PCREATE_ERROR 3PROC
1643051d27SRobert Mustacchi.Os
1743051d27SRobert Mustacchi.Sh NAME
1843051d27SRobert Mustacchi.Nm Pcreate_error
1943051d27SRobert Mustacchi.Nd get Pcreate, Pxcreate error message string
2043051d27SRobert Mustacchi.Sh SYNOPSIS
2143051d27SRobert Mustacchi.Lb libproc
2243051d27SRobert Mustacchi.In libproc.h
2343051d27SRobert Mustacchi.Ft "const char *"
2443051d27SRobert Mustacchi.Fo Pcreate_error
2543051d27SRobert Mustacchi.Fa "int error"
2643051d27SRobert Mustacchi.Fc
2743051d27SRobert Mustacchi.Sh DESCRIPTION
2843051d27SRobert MustacchiThe
2943051d27SRobert Mustacchi.Fn Pcreate_error
3043051d27SRobert Mustacchifunction returns a pointer to a human-readable character string
31*72d3dbb9SYuri Pankovdescribing the error that occurred.
32*72d3dbb9SYuri PankovThe
3343051d27SRobert Mustacchi.Fn Pcreate_error
3443051d27SRobert Mustacchifunction translates errors produced by the
3543051d27SRobert Mustacchi.Xr Pcreate 3PROC
3643051d27SRobert Mustacchiand
3743051d27SRobert Mustacchi.Xr Pxcreate 3PROC
3843051d27SRobert Mustacchifunctions only (passed as the
3943051d27SRobert Mustacchi.Fa perr
4043051d27SRobert Mustacchiargument).
4143051d27SRobert Mustacchi.Sh RETURN VALUES
4243051d27SRobert MustacchiThe
4343051d27SRobert Mustacchi.Fn Pcreate_error
4443051d27SRobert Mustacchifunction always returns a pointer to a character string that describes
4543051d27SRobert Mustacchithe error that occurred, even if it is an unknown error.
4643051d27SRobert Mustacchi.Sh INTERFACE STABILITY
4743051d27SRobert Mustacchi.Sy Uncommitted
4843051d27SRobert Mustacchi.Sh MT-LEVEL
4943051d27SRobert Mustacchi.Sy MT-Safe
5043051d27SRobert Mustacchi.Sh SEE ALSO
5143051d27SRobert Mustacchi.Xr libproc 3LIB ,
5243051d27SRobert Mustacchi.Xr Pcreate 3PROC ,
5343051d27SRobert Mustacchi.Xr Pxcreate 3PROC
54