usr/src/man/man2/msgids.2

   1 '\" te
   2 .\" Copyright (c) 2000, Sun Microsystems, Inc.
   3 .\" All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH MSGIDS 2 "Mar 8, 2000"
   8 .SH NAME
   9 msgids \- discover all message queue identifiers
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 #include <sys/msg.h>
  14
  15 \fBint\fR \fBmsgids\fR(\fBint *\fR\fIbuf\fR, \fBuint_t\fR \fInids\fR, \fBuint_t  *\fR\fIpnids\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBmsgids()\fR function copies all active message queue identifiers from
  22 the system into the user-defined buffer specified by \fIbuf\fR, provided that
  23 the number of such identifiers is not greater than the number of integers the
  24 buffer can contain, as specified by \fInids\fR.  If the size of the buffer is
  25 insufficient to contain all of the active message queue identifiers in the
  26 system, none are copied.
  27 .sp
  28 .LP
  29 Whether or not the size of the buffer is sufficient to contain all of them, the
  30 number of active message queue identifiers in the system is copied into the
  31 unsigned integer pointed to by \fIpnids\fR.
  32 .sp
  33 .LP
  34 If \fInids\fR is 0 or less than the number of active message queue identifiers
  35 in the system, \fIbuf\fR is ignored.
  36 .SH RETURN VALUES
  37 .sp
  38 .LP
  39 Upon successful completion, \fBmsgids()\fR returns \fB0\fR.  Otherwise,
  40 \fB\(mi1\fR is returned and \fBerrno\fR is set to indicate the error.
  41 .SH ERRORS
  42 .sp
  43 .LP
  44 The \fBmsgids()\fR function will fail if:
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBEFAULT\fR\fR
  49 .ad
  50 .RS 10n
  51 The \fIbuf\fR or \fIpnids\fR argument points to an illegal address.
  52 .RE
  53
  54 .SH USAGE
  55 .sp
  56 .LP
  57 The \fBmsgids()\fR function returns a snapshot of all the active message queue
  58 identifiers in the system.  More may be added and some may be removed before
  59 they can be used by the caller.
  60 .SH EXAMPLES
  61 .LP
  62 \fBExample 1 \fR\fBmsgids()\fR example
  63 .sp
  64 .LP
  65 This is sample C code indicating how to use the \fBmsgids()\fR function (see
  66 \fBmsgsnap\fR(2)):
  67
  68 .sp
  69 .in +2
  70 .nf
  71 void
  72 examine_queues()
  73 {
  74      int *ids = NULL;
  75      uint_t nids = 0;
  76      uint_t n;
  77      int i;
  78
  79      for (;;) {
  80           if (msgids(ids, nids, &n) != 0) {
  81                perror("msgids");
  82                exit(1);
  83           }
  84           if (n <= nids)     /* we got them all */
  85                break;
  86           /* we need a bigger buffer */
  87           ids = realloc(ids, (nids = n) * sizeof (int));
  88      }
  89
  90      for (i = 0; i < n; i++)
  91           process_msgid(ids[i]);
  92
  93      free(ids);
  94 }
  95 .fi
  96 .in -2
  97
  98 .SH ATTRIBUTES
  99 .sp
 100 .LP
 101 See \fBattributes\fR(5) for descriptions of the following attributes:
 102 .sp
 103
 104 .sp
 105 .TS
 106 box;
 107 c | c
 108 l | l .
 109 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 110 _
 111 MT-Level        Async-Signal-Safe
 112 .TE
 113
 114 .SH SEE ALSO
 115 .sp
 116 .LP
 117 \fBipcrm\fR(1), \fBipcs\fR(1), \fBIntro\fR(2), \fBmsgctl\fR(2),
 118 \fBmsgget\fR(2), \fBmsgsnap\fR(2), \fBmsgrcv\fR(2), \fBmsgsnd\fR(2),
 119 \fBattributes\fR(5)