Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

shm_unlink(2) [osx man page]

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

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

Check Out this Related Man Page

shm_unlink(3)						     Library Functions Manual						     shm_unlink(3)

shm_unlink - Removes a shared memory object created by a call to the shm_open function (P1003.1b) LIBRARY
Realtime Library (, librt.a) SYNOPSIS
#include <sys/mman.h> int shm_unlink ( const char *name); PARAMETERS
*name Points to the name of the shared memory object. DESCRIPTION
The shm_unlink function removes the name of the shared memory object pointed to by name. If this file descriptor is used by other func- tions, all references to the shared memory object are removed, but content removal is delayed until all open and mapped references to the shared memory object are removed. RETURN VALUES
On a successful call to the shm_unlink function, a value of 0 (zero) is returned. Otherwise, a value of -1 is returned and errno is set to indicate the error. ERRORS
The shm_unlink function fails under the following conditions: [EACCES] Permission to unlink the shared memory object is denied. [ENAMETOOLONG] The length of the name argument 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. RELATED INFORMATION
Functions: close(2), mmap(2), munmap(2), shm_open(3) Guide to Realtime Programming delim off shm_unlink(3)
Man Page

Featured Tech Videos