'\" te
.\" 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]
.TH MQ_GETATTR 3C "Feb 5, 2008"
.SH NAME
mq_getattr \- get message queue attributes
.SH SYNOPSIS
.LP
.nf
#include <mqueue.h>

\fBint\fR \fBmq_getattr\fR(\fBmqd_t\fR \fImqdes\fR, \fBstruct mq_attr *\fR\fImqstat\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fImqdes\fR argument specifies a message queue descriptor. The
\fBmq_getattr()\fR 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 \fImq_attr\fR
structure referenced by the \fImqstat\fR argument.
.sp
.LP
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 \fBmq_setattr\fR(3C) calls:
.sp
.ne 2
.na
\fB\fBmq_flags\fR\fR
.ad
.RS 12n
message queue flags
.RE

.sp
.LP
The following attributes of the message queue are returned as set at message
queue creation:
.sp
.ne 2
.na
\fB\fBmq_maxmsg\fR\fR
.ad
.RS 14n
maximum number of messages
.RE

.sp
.ne 2
.na
\fB\fBmq_msgsize\fR\fR
.ad
.RS 14n
maximum message size
.RE

.sp
.ne 2
.na
\fB\fBmq_curmsgs\fR\fR
.ad
.RS 14n
number of messages currently on the queue.
.RE

.SH RETURN VALUES
.sp
.LP
Upon successful completion, the \fBmq_getattr()\fR function returns \fB0\fR.
Otherwise, the function returns \fB\(mi1\fR and sets \fBerrno\fR to indicate
the error.
.SH ERRORS
.sp
.LP
The  \fBmq_getattr()\fR function will fail if:
.sp
.ne 2
.na
\fB\fBEBADF\fR\fR
.ad
.RS 10n
The \fImqdes\fR argument is not a valid message queue descriptor.
.RE

.sp
.ne 2
.na
\fB\fBENOSYS\fR\fR
.ad
.RS 10n
The \fBmq_getattr()\fR function is not supported by the system.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Committed
_
MT-Level	MT-Safe
_
Standard	See \fBstandards\fR(5).
.TE

.SH SEE ALSO
.sp
.LP
\fBmsgctl\fR(2), \fBmsgget\fR(2), \fBmsgrcv\fR(2), \fBmsgsnd\fR(2),
\fBmqueue.h\fR(3HEAD), \fBmq_open\fR(3C), \fBmq_send\fR(3C),
\fBmq_setattr\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)
.SH NOTES
.sp
.LP
Solaris 2.6 was the first release to support the Asynchronous Input and Output
option. Prior to this release, this function always returned \fB\(mi1\fR and
set \fBerrno\fR to \fBENOSYS\fR.