Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved.
Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.
The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
This notice shall appear on any product containing this material.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
#include <mqueue.h> int mq_getattr(mqd_t mqdes, struct mq_attr *mqstat);
The mqdes argument specifies a message queue descriptor. The mq_getattr() function is used to get status information and attributes of the message queue and the open message queue description associated with the message queue descriptor. The results are returned in the mq_attr structure referenced by the mqstat argument.
Upon return, the following members will have the values associated with the open message queue description as set when the message queue was opened and as modified by subsequent mq_setattr(3C) calls:
mq_flags
message queue flags
The following attributes of the message queue are returned as set at message queue creation:
mq_maxmsg
maximum number of messages
mq_msgsize
maximum message size
mq_curmsgs
number of messages currently on the queue.
Upon successful completion, the mq_getattr() function returns 0. Otherwise, the function returns -1 and sets errno to indicate the error.
The mq_getattr() function will fail if:
EBADF
The mqdes argument is not a valid message queue descriptor.
ENOSYS
The mq_getattr() function is not supported by the system.
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
| Interface Stability | Committed |
| MT-Level | MT-Safe |
| Standard | See standards(5). |
msgctl(2), msgget(2), msgrcv(2), msgsnd(2), mqueue.h(3HEAD), mq_open(3C), mq_send(3C), mq_setattr(3C), attributes(5), standards(5)
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.