Content-type: text/html Man page of shmdt

shmdt

Section: System Calls (2)
Index Return to Main Contents
 

NAME

shmdt - Detaches a shared memory region  

SYNOPSIS

#include <sys/shm.h>

int shmdt(
        const void *addr);

Application developers may want to specify #include statements for <sys/types.h> and <sys/ipc.h> before the one for <sys/shm.h> if programs are being developed for multiple platforms. The additional #include statements are not required on Tru64 UNIX systems or by ISO or X/Open standards, but may be required on other vendors' systems that conform to these standards.  

STANDARDS

Interfaces documented on this reference page conform to industry standards as follows:

shmdt():  XPG4, XPG4-UNIX

Refer to the standards(5) reference page for more information about industry standards and associated tags.  

PARAMETERS

Specifies the starting virtual address for the shared memory region to be detached. This is the address returned by a previous shmat() call.  

DESCRIPTION

The shmdt() function detaches the shared memory region at the address specified by the addr parameter. Other instances of the region attached at other addresses are unaffected.  

RETURN VALUES

Upon successful completion, the shmdt() function decrements the value of shm_nattach in the data structure associated with the shared memory ID of the attached shared memory segment and returns 0 (zero). Upon failure, the shared memory segment is not detached, -1 is returned, and errno is set to indicate the error.  

ERRORS

The shmdt() function sets errno to the specified values for the following conditions: The addr parameter does not specify the starting address of a shared memory region.  

RELATED INFORMATION

Functions: shmat(2), shmctl(2), shmget(2)

Data structures: shmid_ds(4)

Standards: standards(5) delim off


 

Index

NAME
SYNOPSIS
STANDARDS
PARAMETERS
DESCRIPTION
RETURN VALUES
ERRORS
RELATED INFORMATION

This document was created by man2html, using the manual pages.
Time: 02:40:16 GMT, October 02, 2010