shm_unlink(2) [osx man page]

SHM_UNLINK(2)						      BSD System Calls Manual						     SHM_UNLINK(2)

NAME

     shm_unlink -- remove shared memory object

SYNOPSIS

     #include <sys/mman.h>

     int
     shm_unlink(const char *name);

DESCRIPTION

     The shm_unlink() function disassociates the shared memory object specified by name from that name.  The resources associated with the shared
     memory object remain intact until the last file descriptor reference is removed, e.g., by close(2) or munmap(2), at which point the resources
     are reclaimed (if no references exist at the time of the call to shm_unlink(), the resources are reclaimed immediately).  The name can only
     be reused when it is bound to a new shared memory object with a call to shm_open(2) with the O_CREAT flag.

RETURN VALUES

     Upon successful completion, a value of 0 is returned.  Otherwise, a value of -1 is returned and errno is set to indicate the error, and the
     named shared memory object will remain unchanged.

ERRORS

     The shm_unlink() succeeds unless:

     [EACCES]		Permission is denied to be remove the object.

     [ENAMETOOLONG]	name exceeded the name size limit.  This is currently PSHMNAMLEN characters (defined in <sys/posix_shm.h>), but this may
			change in the future.

     [ENOENT]		The named object does not exist.

SEE ALSO

     close(2), mmap(2), munmap(2), shm_open(2), shmat(2), shmctl(2)

HISTORY

     shm_open() is specified in the POSIX Realtime Extension (1003.1b-1993/1003.1i-1995).

Darwin								  August 31, 2006							    Darwin

shm_unlink(3RT) 					    Realtime Library Functions						   shm_unlink(3RT)

NAME

       shm_unlink - remove a shared memory object

SYNOPSIS

       cc [ flag... ] file... -lrt [ library... ]
       #include <sys/mman.h>

       int shm_unlink(const char *name);

DESCRIPTION

       The shm_unlink() function removes the name of the shared memory object named by the string pointed to by name. If one or more references to
       the shared memory object exists when the object is unlinked, the name is removed before shm_unlink() 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.

RETURN VALUES

       Upon  successful  completion, shm_unlink() returns 0. Otherwise it returns -1 and sets errno to indicate the error condition, and the named
       shared memory object is not affected by this function call.

ERRORS

       The  shm_unlink() function will fail if:

       EACCES		       Permission is denied to unlink the named shared memory object.

       ENAMETOOLONG	       The length of the name  string  exceeds	 PATH_MAX,  or	a  pathname  component	is  longer  than   NAME_MAX  while
			       _POSIX_NO_TRUNC is in effect.

       ENOENT		       The named shared memory object does not exist.

       ENOSYS		       The shm_unlink() function is not supported by the system.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       close(2), mmap(2), mlock(3C), shm_open(3RT), attributes(5), standards(5)

NOTES

       Solaris 2.6 was the first release to support the Asynchronous Input and Output option. Prior to this release, this function always returned
       -1 and set errno to ENOSYS.

SunOS 5.10							    28 Jun 2002 						   shm_unlink(3RT)