Changes: Ready for 5.13
[man-pages.git] / man3 / sem_close.3
blob766e710e49e6d4dbb1aae16556a9a2b707305e52
1 .\" Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
2 .\"
3 .\" %%%LICENSE_START(VERBATIM)
4 .\" Permission is granted to make and distribute verbatim copies of this
5 .\" manual provided the copyright notice and this permission notice are
6 .\" preserved on all copies.
7 .\"
8 .\" Permission is granted to copy and distribute modified versions of this
9 .\" manual under the conditions for verbatim copying, provided that the
10 .\" entire resulting derived work is distributed under the terms of a
11 .\" permission notice identical to this one.
12 .\"
13 .\" Since the Linux kernel and libraries are constantly changing, this
14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
15 .\" responsibility for errors or omissions, or for damages resulting from
16 .\" the use of the information contained herein.  The author(s) may not
17 .\" have taken the same level of care in the production of this manual,
18 .\" which is licensed free of charge, as they might when working
19 .\" professionally.
20 .\"
21 .\" Formatted or processed versions of this manual, if unaccompanied by
22 .\" the source, must acknowledge the copyright and authors of this work.
23 .\" %%%LICENSE_END
24 .\"
25 .TH SEM_CLOSE 3 2021-03-22 "Linux" "Linux Programmer's Manual"
26 .SH NAME
27 sem_close \- close a named semaphore
28 .SH SYNOPSIS
29 .nf
30 .B #include <semaphore.h>
31 .PP
32 .BI "int sem_close(sem_t *" sem );
33 .fi
34 .PP
35 Link with \fI\-pthread\fP.
36 .SH DESCRIPTION
37 .BR sem_close ()
38 closes the named semaphore referred to by
39 .IR sem ,
40 allowing any resources that the system has allocated to
41 the calling process for this semaphore to be freed.
42 .SH RETURN VALUE
43 On success
44 .BR sem_close ()
45 returns 0; on error, \-1 is returned, with
46 .I errno
47 set to indicate the error.
48 .SH ERRORS
49 .TP
50 .B EINVAL
51 .I sem
52 is not a valid semaphore.
53 .SH ATTRIBUTES
54 For an explanation of the terms used in this section, see
55 .BR attributes (7).
56 .ad l
57 .nh
58 .TS
59 allbox;
60 lbx lb lb
61 l l l.
62 Interface       Attribute       Value
64 .BR sem_close ()
65 T}      Thread safety   MT-Safe
66 .TE
67 .hy
68 .ad
69 .sp 1
70 .SH CONFORMING TO
71 POSIX.1-2001, POSIX.1-2008.
72 .SH NOTES
73 All open named semaphores are automatically closed on process
74 termination, or upon
75 .BR execve (2).
76 .SH SEE ALSO
77 .BR sem_getvalue (3),
78 .BR sem_open (3),
79 .BR sem_post (3),
80 .BR sem_unlink (3),
81 .BR sem_wait (3),
82 .BR sem_overview (7)