RTEMS 4.6.2 On-Line Library

Message Buffer Manager del_mbf - Delete MessageBuffer

RTEMS ITRON 3.0 API User's Guide

6.4.2: del_mbf - Delete MessageBuffer

CALLING SEQUENCE:

ER del_mbf(
  ID mbfid
);

STATUS CODES:

E_OK - Normal Completion

E_ID - Invalid ID number (mbfid was invalid or could not be used)

E_NOEXS - Object does not exist (the messagebuffer specified by mbfid does not exist)

E_OACV - Object access violation (A mbfid less than -4 was specified from a user task. This is implementation dependent.)

EN_OBJNO - An object number which could not be accessed on the target node is specified.

EN_CTXID - Specified an object on another node when the system call was issued from a task in dispatch disabled state or from a task-independent portion

DESCRIPTION:

This routine deletes the message buffer specified by mbfid. Issuing this system call releases memory area used for the control block of the associated message buffer and the buffer area used for storing messages.

This routine will complete normally even if there are tasks waiting to send or receive messages at the message buffer. In that case, an E_DLT error will be returned to each waiting task. If there are messages still in the message buffer, they will be deleted along with the message buffer and no error will result.

NOTES:

Multiprocessing is not supported. Thus none of the "EN_" status codes will be returned.

RTEMS ITRON 3.0 API User's Guide