Standard C Library Functions mqgetattr(3C)
NAME
mqgetattr - get message queue attributes
SYNOPSIS
#include
int mqgetattr(mqdt mqdes, struct mqattr *mqstat);
DESCRIPTION
The mqdes argument specifies a message queue descriptor. The
mqgetattr() 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 mqattr 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 subse-
quent mqsetattr(3C) calls:
mqflags message queue flags
The following attributes of the message queue are returned
as set at message queue creation:
mqmaxmsg maximum number of messages
mqmsgsize maximum message size
mqcurmsgs number of messages currently on the queue.
RETURN VALUES
Upon successful completion, the mqgetattr() function
returns 0. Otherwise, the function returns -1 and sets errno
to indicate the error.
ERORS
The mqgetattr() function will fail if:
EBADF The mqdes argument is not a valid message queue
descriptor.
SunOS 5.11 Last change: 5 Feb 2008 1
Standard C Library Functions mqgetattr(3C)
ENOSYS The mqgetattr() function is not supported by the
system.
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
ATRIBUTE TYPE ATRIBUTE VALUE
Interface Stability Committed
MT-Level MT-Safe
Standard See standards(5).
SEE ALSO
msgctl(2), msgget(2), msgrcv(2), msgsnd(2), mqueue.h(3HEAD),
mqopen(3C), mqsend(3C), mqsetattr(3C), attributes(5),
standards(5)
NOTES
Solaris 2.6 was the first release to support the Asynchro-
nous Input and Output option. Prior to this release, this
function always returned -1 and set errno to ENOSYS.
SunOS 5.11 Last change: 5 Feb 2008 2
|