'\" te
.\" Copyright (c) 2008, 2012, Oracle and/or its affiliates. All rights reserved.
.\" Copyright 1989 AT&T
.\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
.\" 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  http://www.opengroup.org/bookstore/.
.\" 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.  This notice shall appear on any product containing this material.
.TH shm_unlink 3C "31 Jan 2012" "SunOS 5.11" "Standard C Library Functions"
.SH NAME
shm_unlink \- remove a shared memory object
.SH SYNOPSIS
.LP
.nf
#include <sys/mman.h>

\fBint\fR \fBshm_unlink\fR(\fBconst char *\fR\fIname\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBshm_unlink()\fR function removes the name of the shared memory object named by the string pointed to by \fIname\fR. If one or more references to the shared memory object exists when the object is unlinked, the name is removed before \fBshm_unlink()\fR returns, but the removal of the memory object contents will be postponed until all open and mapped references to the shared memory object have been removed.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, \fBshm_unlink()\fR returns \fB0\fR. Otherwise it returns \fB\(mi1\fR and sets \fBerrno\fR to indicate the error condition, and the named shared memory object is not affected by this function call.
.SH ERRORS
.sp
.LP
The  \fBshm_unlink()\fR function will fail if:
.sp
.ne 2
.mk
.na
\fB\fBEACCES\fR\fR
.ad
.RS 16n
.rt  
Permission is denied to unlink the named shared memory object.
.RE

.sp
.ne 2
.mk
.na
\fB\fBENAMETOOLONG\fR\fR
.ad
.RS 16n
.rt  
The length of the \fIname\fR string exceeds  \fBPATH_MAX\fR, or a pathname component is longer than  \fINAME_MAX\fR while  \fB_POSIX_NO_TRUNC\fR is in effect.
.RE

.sp
.ne 2
.mk
.na
\fB\fBENOENT\fR\fR
.ad
.RS 16n
.rt  
The named shared memory object does not exist.
.RE

.sp
.ne 2
.mk
.na
\fB\fBENOSYS\fR\fR
.ad
.RS 16n
.rt  
The \fBshm_unlink()\fR function is not supported by the system.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
lw(2.75i) |lw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
\fBATTRIBUTE TYPE\fR\fBATTRIBUTE VALUE\fR
_
Interface StabilityCommitted
_
MT-LevelMT-Safe
_
StandardSee \fBstandards\fR(5).
.TE

.SH SEE ALSO
.sp
.LP
\fBclose\fR(2), \fBmmap\fR(2), \fBmlock\fR(3C), \fBshm_open\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)