Sun Microsystems, Inc.
spacerspacer
spacer   www.sun.com docs.sun.com | | |  
spacer
black dot
   
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   Q   R   S   T   U   V   W   X   Y   Z
    
 
Realtime Library Functionsmq_getattr(3RT)


NAME

 mq_getattr - get message queue attributes

SYNOPSIS

 
cc [ flag... ] file... -lrt [ library... ]
#include <mqueue.h> 
int mq_getattr(mqd_t mqdes, struct mq_attr *mqstat);

DESCRIPTION

 

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(3RT) 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.

RETURN VALUES

 

Upon successful completion, the mq_getattr() function returns 0. Otherwise, the function returns -1 and sets errno to indicate the error.

ERRORS

 

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.

ATTRIBUTES

 

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
MT-LevelMT-Safe

SEE ALSO

 

msgctl(2), msgget(2), msgrcv(2), msgsnd(2), mq_open(3RT), mq_send(3RT), mq_setattr(3RT), attributes(5), mqueue(3HEAD)

NOTES

 

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.


SunOS 5.9Go To TopLast Changed 22 Jun 1988

 
      
      
Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.