'\" te
.\" Copyright 1989 AT&T.  Copyright (c) 2004, 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 MSGCTL 2 "Mar 22, 2004"
.SH NAME
msgctl \- message control operations
.SH SYNOPSIS
.LP
.nf
#include <sys/msg.h>

\fBint\fR \fBmsgctl\fR(\fBint\fR \fImsqid\fR, \fBint\fR \fIcmd\fR, \fBstruct msqid_ds *\fR\fIbuf\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBmsgctl()\fR function provides a variety of message control operations as
specified by \fIcmd\fR. The following \fIcmd\fRs are available:
.sp
.ne 2
.na
\fB\fBIPC_STAT\fR\fR
.ad
.RS 12n
Place the current value of each member of the data structure associated with
\fImsqid\fR into the structure pointed to by \fIbuf\fR. The contents of this
structure are defined in \fBIntro\fR(2).
.RE

.sp
.ne 2
.na
\fB\fBIPC_SET\fR\fR
.ad
.RS 12n
Set the value of the following members of the data structure associated with
\fImsqid\fR to the corresponding value found in the structure pointed to by
\fIbuf\fR:
.sp
.in +2
.nf
msg_perm.uid
msg_perm.gid
msg_perm.mode /* access permission bits only */
msg_qbytes
.fi
.in -2

This command can be executed only by a process that has either the
{\fBPRIV_IPC_OWNER\fR} privilege or an effective user \fBID\fR equal to the
value of \fBmsg_perm.cuid\fR or \fBmsg_perm.uid\fR in the data structure
associated with \fImsqid\fR. Only a process with the
{\fBPRIV_SYS_IPC_CONFIG\fR} privilege can raise the value of \fBmsg_qbytes\fR.
.RE

.sp
.ne 2
.na
\fB\fBIPC_RMID\fR\fR
.ad
.RS 12n
Remove the message queue identifier specified by \fImsqid\fR from the system
and destroy the message queue and data structure associated with it. This
\fIcmd\fR can only be executed by a process that has an effective user \fBID\fR
either with appropriate privileges asserted in the effective set or equal to
the value of \fBmsg_perm.cuid\fR or  \fBmsg_perm.uid\fR in the data structure
associated with \fImsqid\fR. The \fIbuf\fR argument is ignored.
.RE

.SH RETURN VALUES
.sp
.LP
Upon successful completion, \fBmsgctl()\fR returns \fB0\fR. Otherwise, it
returns \fB\(mi1\fR and sets \fBerrno\fR to indicate the error.
.SH ERRORS
.sp
.LP
The \fBmsgctl()\fR function will fail if:
.sp
.ne 2
.na
\fB\fBEACCES\fR\fR
.ad
.RS 13n
The \fIcmd\fR argument is \fBIPC_STAT\fR and operation permission is denied to
the calling process (see \fBIntro\fR(2)).
.RE

.sp
.ne 2
.na
\fB\fBEFAULT\fR\fR
.ad
.RS 13n
The \fIbuf\fR argument points to an illegal address.
.RE

.sp
.ne 2
.na
\fB\fBEINVAL\fR\fR
.ad
.RS 13n
The \fImsqid\fR argument is not a valid message queue identifier; or the
\fIcmd\fR argument is not a valid command or is \fBIPC_SET\fR and
\fBmsg_perm.uid\fR or \fBmsg_perm.gid\fR is not valid.
.RE

.sp
.ne 2
.na
\fB\fBEOVERFLOW\fR\fR
.ad
.RS 13n
The \fIcmd\fR argument is \fBIPC_STAT\fR and \fIuid\fR or \fIgid\fR is too
large to be stored in the structure pointed to by \fIbuf\fR.
.RE

.sp
.ne 2
.na
\fB\fBEPERM\fR\fR
.ad
.RS 13n
The \fIcmd\fR argument is \fBIPC_RMID\fR or \fBIPC_SET\fR, the
{\fBPRIV_SYS_IPC_OWNER\fR} privilege is not asserted in the effective set of
the calling process, and is not equal to the value of \fBmsg_perm.cuid\fR or
\fBmsg_perm.uid\fR in the data structure associated with \fImsqid\fR.
.sp
The \fIcmd\fR argument is \fBIPC_SET,\fR an attempt is being made to increase
to the value of \fBmsg_qbytes\fR, and the {\fBPRIV_SYS_IPC_CONFIG\fR} privilege
is not asserted in the effective set of the calling process.
.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	Standard
.TE

.SH SEE ALSO
.sp
.LP
\fBIntro\fR(2), \fBmsgget\fR(2), \fBmsgrcv\fR(2), \fBmsgsnd\fR(2),
\fBattributes\fR(5), \fBprivileges\fR(5), \fBstandards\fR(5)