mq_getattr(2) [hpux man page]

mq_getattr(2)							System Calls Manual						     mq_getattr(2)

NAME

       mq_getattr - get status information and attributes associated with a message queue

SYNOPSIS

DESCRIPTION

       The  system  call  collects status information and attributes associated with the message queue specified by mqdes which is copied into the
       structure referenced by mqstat.

       Upon a successful return, the mq_msgsize and mq_maxmsg fields within the mq_attr structure contain the maximum size of a message  for  this
       queue  and the maximum number of messages that can be queued at any time. The mq_curmsgs field contains the number of messages currently on
       the queue. In addition, the mq_flags field contains the message queue blocking status associated with this mqdes.

       To use this function, link in the realtime library by specifying on the compiler or linker command line.

RETURN VALUE

       returns the following values:

	      Successful completion.

	      Failure.
		   is set to indicate the error.

ERRORS

       If fails, is set to one of the following values:

	      [EBADF]	     mqdes is not a valid message queue descriptor.

	      [EINVAL]	     mqstat does not point to a valid mq_attr structure.

	      [ENOSYS]	     is not supported by the implementation.

SEE ALSO

       mq_open(2), mq_setattr(2).

STANDARDS CONFORMANCE

																     mq_getattr(2)

mq_getattr(3C)						   Standard C Library Functions 					    mq_getattr(3C)

NAME

       mq_getattr - get message queue attributes

SYNOPSIS

       #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(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.

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 TYPE		     |ATTRIBUTE 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), mq_open(3C), mq_send(3C), mq_setattr(3C), attributes(5), standards(5)

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.11							    5 Feb 2008							    mq_getattr(3C)