share/man/man3c/shm_unlink.3c

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright 1989 AT&T
   4 .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
   5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH SHM_UNLINK 3C "Feb 5, 2008"
  13 .SH NAME
  14 shm_unlink \- remove a shared memory object
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 #include <sys/mman.h>
  19
  20 \fBint\fR \fBshm_unlink\fR(\fBconst char *\fR\fIname\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBshm_unlink()\fR function removes the name of the shared memory object
  27 named by the string pointed to by \fIname\fR. If one or more references to the
  28 shared memory object exists when the object is unlinked, the name is removed
  29 before \fBshm_unlink()\fR returns, but the removal of the memory object
  30 contents will be postponed until all open and mapped references to the shared
  31 memory object have been removed.
  32 .SH RETURN VALUES
  33 .sp
  34 .LP
  35 Upon successful completion, \fBshm_unlink()\fR returns \fB0\fR. Otherwise it
  36 returns \fB\(mi1\fR and sets \fBerrno\fR to indicate the error condition, and
  37 the named shared memory object is not affected by this function call.
  38 .SH ERRORS
  39 .sp
  40 .LP
  41 The  \fBshm_unlink()\fR function will fail if:
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fBEACCES\fR \fR
  46 .ad
  47 .RS 17n
  48 Permission is denied to unlink the named shared memory object.
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBENAMETOOLONG\fR \fR
  55 .ad
  56 .RS 17n
  57 The length of the \fIname\fR string exceeds  \fBPATH_MAX\fR, or a pathname
  58 component is longer than  \fINAME_MAX\fR while  \fB_POSIX_NO_TRUNC\fR is in
  59 effect.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBENOENT\fR \fR
  66 .ad
  67 .RS 17n
  68 The named shared memory object does not exist.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBENOSYS\fR \fR
  75 .ad
  76 .RS 17n
  77 The \fBshm_unlink()\fR function is not supported by the system.
  78 .RE
  79
  80 .SH ATTRIBUTES
  81 .sp
  82 .LP
  83 See \fBattributes\fR(5) for descriptions of the following attributes:
  84 .sp
  85
  86 .sp
  87 .TS
  88 box;
  89 c | c
  90 l | l .
  91 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  92 _
  93 Interface Stability     Committed
  94 _
  95 MT-Level        MT-Safe
  96 _
  97 Standard        See \fBstandards\fR(5).
  98 .TE
  99
 100 .SH SEE ALSO
 101 .sp
 102 .LP
 103 \fBclose\fR(2), \fBmmap\fR(2), \fBmlock\fR(3C), \fBshm_open\fR(3C),
 104 \fBattributes\fR(5), \fBstandards\fR(5)
 105 .SH NOTES
 106 .sp
 107 .LP
 108 Solaris 2.6 was the first release to support the Asynchronous Input and Output
 109 option. Prior to this release, this function always returned \fB\(mi1\fR and
 110 set \fBerrno\fR to \fBENOSYS\fR.