shm_delete_handle()

Updated: April 19, 2023

Delete a handle to a shared memory object

Synopsis:

#include <sys/mman.h>

int shm_delete_handle( shm_handle_t handle );

Arguments:

handle
The shared memory object handle to delete.

Library:

libc

Use the -l c option to qcc to link against this library. This library is usually included automatically.

Description:

The shm_delete_handle() function deletes the given handle to a shared memory object. Typically, this function isn't required, because when the recipient process (i.e., the one that received the handle) attempts to open the object with shm_open_handle(), the handle is implicitly deleted. You can explicitly delete the handle to perform cleanup when you decide that it isn't needed, from either the creator process or the recipient process.

Returns:

0 on success, or -1 if an error occurred (errno is set).

Errors:

ESRCH
The specified handle isn't found (e.g. does not exist), or the calling process isn't associated with the handle (i.e. the process isn't the source or destination process).

Classification:

QNX Neutrino

Safety:  
Cancellation point No
Interrupt handler No
Signal handler Yes
Thread Yes