]> git.saurik.com Git - apple/xnu.git/blame - bsd/man/man3/posix_spawnattr_setsigdefault.3
xnu-3789.70.16.tar.gz
[apple/xnu.git] / bsd / man / man3 / posix_spawnattr_setsigdefault.3
CommitLineData
2d21ac55
A
1.\"
2.\" Copyright (c) 2000-2007 Apple Inc. All rights reserved.
3.\"
4.\" @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5.\"
6.\" This file contains Original Code and/or Modifications of Original Code
7.\" as defined in and that are subject to the Apple Public Source License
8.\" Version 2.0 (the 'License'). You may not use this file except in
9.\" compliance with the License. The rights granted to you under the License
10.\" may not be used to create, or enable the creation or redistribution of,
11.\" unlawful or unlicensed copies of an Apple operating system, or to
12.\" circumvent, violate, or enable the circumvention or violation of, any
13.\" terms of an Apple operating system software license agreement.
14.\"
15.\" Please obtain a copy of the License at
16.\" http://www.opensource.apple.com/apsl/ and read it before using this file.
17.\"
18.\" The Original Code and all software distributed under the License are
19.\" distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20.\" EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21.\" INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22.\" FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23.\" Please see the License for the specific language governing rights and
24.\" limitations under the License.
25.\"
26.\" @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27.\"
28.\" @(#)posix_spawnattr_setsigdefault.3
29.
30.Dd August 22, 2007
31.Dt POSIX_SPAWNATTR_SETSIGDEFAULT 3
32.Os "Mac OS X"
33.Sh NAME
34.Nm posix_spawnattr_setsigdefault
35.Nm posix_spawnattr_getsigdefault
36.Nd set or get the
37.Em spawn-sigdefault
38attribute on a
39.Em posix_spawnattr_t
40.Sh SYNOPSIS
41.Fd #include <spawn.h>
42.Ft int
43.Fo posix_spawnattr_setsigdefault
44.Fa "posix_spawnattr_t *restrict attr"
45.Fa "const sigset_t *restrict sigdefault"
46.Fc
47.Ft int
48.Fo posix_spawnattr_getsigdefault
49.Fa "const posix_spawnattr_t *restrict attr"
50.Fa "sigset_t *restrict sigdefault"
51.Fc
52.Sh DESCRIPTION
53The
54.Fn posix_spawnattr_setsigdefault
55function sets the
56.Fa sigdefault
57on the attributes object referenced by
58.Fa attr .
59.Pp
60The
61.Fn posix_spawnattr_getsigdefault
62function retrieves the
63.Fa sigdefault
64on the attributes object referenced by
65.Fa attr .
66.Pp
67The argument
68.Fa sigdefault
69is the set of signals to be returned to default behaviour in the new
70process on creation if the
71.Em POSIX_SPAWN_SETSIGDEF
72flag is set in the
73.Em posix_spawnattr_t .
74It's default value must be set via a call to
75.Xr posix_spawnattr_setflags 3
76or the behaviour is undefined.
77.Sh RETURN VALUES
78On success, these functions return 0; on failure they return an error
79number from
80.In errno.h .
81Additionally, if successful,
82.Fn posix_spawnattr_getsigdefault
83will modify the contents of the
84.Fa sigdefault
85parameter with the current attribute value.
86.Sh ERRORS
87These functions may fail if:
88.Bl -tag -width Er
89.\" ==========
90.It Bq Er EINVAL
91The value specified by
92.Fa attr
93is invalid.
94.\" ==========
95.It Bq Er EINVAL
96The value of
97.Fa attr
98is invalid.
99.El
100.Sh SEE ALSO
101.Xr posix_spawn 2 ,
102.Xr posix_spawnp 2 ,
103.Xr posix_spawnattr_init 3 ,
104.Xr posix_spawnattr_destroy 3 ,
105.Xr posix_spawnattr_setflags 3
106.Sh STANDARDS
107.St -susv3 [SPN]
108.Sh HISTORY
109The
110.Fn posix_spawnattr_setsigdefault
111and
112.Fn posix_spawnattr_getsigdefault
113function calls appeared in
114.St -susv3 [SPN] .