(split) LDP: Release pages for LDP v3.39.

[linuxjm/LDP_man-pages.git] / release / man3 / mq_getattr.3

diff --git a/release/man3/mq_getattr.3 b/release/man3/mq_getattr.3
index d603017..68857cb 100644 (file)
--- a/release/man3/mq_getattr.3
+++ b/release/man3/mq_getattr.3
@@ -1,4 +1,4 @@
-'\" t
+.\" t

 .\" Hey Emacs! This file is -*- nroff -*- source.
 .\"
 .\" Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com>
 .\" Hey Emacs! This file is -*- nroff -*- source.
 .\"
 .\" Copyright (C) 2006 Michael Kerrisk <mtk.manpages@gmail.com>


@@ -23,140 +23,74 @@
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
 .\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
 .\"

-.\" Japanese Version Copyright (c) 2006 Akihiro MOTOKI all rights reserved.
-.\" Translated 2006-04-23, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
-.\" Updated 2008-11-09, Akihiro MOTOKI, LDP v3.13
+.\"*******************************************************************

 .\"
 .\"

-.TH MQ_GETATTR 3 2008-09-29 "Linux" "Linux Programmer's Manual"
-.SH ̾Á°
-mq_getattr, mq_setattr \- ¥á¥Ã¥»¡¼¥¸¥­¥å¡¼¤Î°À­¤òÀßÄê/¼èÆÀ¤¹¤ë
-.SH ½ñ¼°
+.\" This file was generated with po4a. Translate the source file.
+.\"
+.\"*******************************************************************
+.TH MQ_GETATTR 3 2010\-08\-29 Linux "Linux Programmer's Manual"
+.SH 名前
+mq_getattr, mq_setattr \- メッセージキューの属性を設定/取得する
+.SH 書式

 .nf
 .nf

-.B #include <mqueue.h>
+\fB#include <mqueue.h>\fP

 .sp
 .sp

-.BI "mqd_t mq_getattr(mqd_t " mqdes ", struct mq_attr *" attr );
+\fBint mq_getattr(mqd_t \fP\fImqdes\fP\fB, struct mq_attr *\fP\fIattr\fP\fB);\fP

 
 

-.BI "mqd_t mq_setattr(mqd_t " mqdes ", struct mq_attr *" newattr ","
-.BI "                 struct mq_attr *" oldattr );
+\fBint mq_setattr(mqd_t \fP\fImqdes\fP\fB, struct mq_attr *\fP\fInewattr\fP\fB,\fP
+\fB                 struct mq_attr *\fP\fIoldattr\fP\fB);\fP

 .fi
 .sp
 .fi
 .sp

-\fI\-lrt\fP ¤Ç¥ê¥ó¥¯¤¹¤ë¡£
-.SH ÀâÌÀ
-.BR mq_getattr ()
-¤È
-.BR mq_setattr ()
-¤Ï¡¢µ­½Ò»Ò
-.I mqdes
-¤Ç»²¾È¤µ¤ì¤ë¥á¥Ã¥»¡¼¥¸¥­¥å¡¼¤Î°À­¤Î¼èÆÀ¤ÈÊѹ¹¤ò¤½¤ì¤¾¤ì¹Ô¤¦¡£
+\fI\-lrt\fP でリンクする。
+.SH 説明
+\fBmq_getattr\fP()  と \fBmq_setattr\fP()  は、記述子 \fImqdes\fP
+で参照されるメッセージキューの属性の取得と変更をそれぞれ行う。

 
 

-.BR mq_getattr ()
-¤Ï¡¢
-.I attr
-¤¬»Ø¤¹¥Ð¥Ã¥Õ¥¡¤Ë
-.I mq_attr
-¹½Â¤ÂΤò³ÊǼ¤·¤ÆÊÖ¤¹¡£¤³¤Î¹½Â¤ÂΤϰʲ¼¤Î¤è¤¦¤ËÄêµÁ¤µ¤ì¤Æ¤¤¤ë:
+\fBmq_getattr\fP()  は、 \fIattr\fP が指すバッファに \fImq_attr\fP
+構造体を格納して返す。この構造体は以下のように定義されている:

 .in +4n
 .nf
 
 struct mq_attr {
 .in +4n
 .nf
 
 struct mq_attr {

-    long mq_flags;       /* ¥Õ¥é¥°: 0 ¤« O_NONBLOCK */
-    long mq_maxmsg;      /* ¥­¥å¡¼¤ÎºÇÂç¥á¥Ã¥»¡¼¥¸¿ô */
-    long mq_msgsize;     /* ºÇÂç¥á¥Ã¥»¡¼¥¸¥µ¥¤¥º (¥Ð¥¤¥Èñ°Ì) */
-    long mq_curmsgs;     /* ¥­¥å¡¼¤Ë¸½ºßÆþ¤Ã¤Æ¤¤¤ë¥á¥Ã¥»¡¼¥¸¿ô */
+    long mq_flags;       /* フラグ: 0 か O_NONBLOCK */
+    long mq_maxmsg;      /* キューの最大メッセージ数 */
+    long mq_msgsize;     /* 最大メッセージサイズ (バイト単位) */
+    long mq_curmsgs;     /* キューに現在入っているメッセージ数 */

 };
 .fi
 .in
 .PP
 };
 .fi
 .in
 .PP

-.I mq_flags
-¥Õ¥£¡¼¥ë¥É¤Ë¤Ï¡¢¥ª¡¼¥×¥ó¥á¥Ã¥»¡¼¥¸¥­¥å¡¼µ­½Ò (open message queue
-description) ¤Ë´ØÏ¢ÉÕ¤±¤é¤ì¤Æ¤¤¤ë¥Õ¥é¥°¤¬³ÊǼ¤µ¤ì¤ë¡£
-¤³¤Î¥Õ¥£¡¼¥ë¥É¤Ï
-.BR mq_open (3)
-¤Ç¥­¥å¡¼¤¬ºîÀ®¤µ¤ì¤ëºÝ¤Ë½é´ü²½¤µ¤ì¤ë¡£
-¤³¤Î¥Õ¥£¡¼¥ë¥É¤Ë¸½¤ì¤ë¥Õ¥é¥°¤Ï
-.B O_NONBLOCK
-¤À¤±¤Ç¤¢¤ë¡£
+\fImq_flags\fP フィールドには、オープンメッセージキュー記述 (open message queue description)
+に関連付けられているフラグが格納される。 このフィールドは \fBmq_open\fP(3)  でキューが作成される際に初期化される。
+このフィールドに現れるフラグは \fBO_NONBLOCK\fP だけである。

 
 

-.I mq_maxmsg
-¤È
-.I mq_msgsize
-¥Õ¥£¡¼¥ë¥É¤Ï
-.BR mq_open (3)
-¤Ç¥á¥Ã¥»¡¼¥¸¥­¥å¡¼¤¬ºîÀ®¤µ¤ì¤ëºÝ¤Ë¥»¥Ã¥È¤µ¤ì¤ë¡£
-.I mq_maxmsg
-¥Õ¥£¡¼¥ë¥É¤Ï¡¢
-.BR mq_send (3)
-¤ò»È¤Ã¤Æ¥­¥å¡¼¤ËÆþ¤ì¤ë¤³¤È¤¬¤Ç¤­¤ë¥á¥Ã¥»¡¼¥¸¿ô¤Î¾å¸Â¤Ç¤¢¤ë¡£
-.I mq_msgsize
-¥Õ¥£¡¼¥ë¥É¤Ï¡¢¥­¥å¡¼¤ËÆþ¤ì¤ë¤³¤È¤¬¤Ç¤­¤ë¥á¥Ã¥»¡¼¥¸¤Î
-¾å¸Â¥µ¥¤¥º¤Ç¤¢¤ë¡£
-¤³¤ì¤é¤Î¥Õ¥£¡¼¥ë¥É¤Ï¤É¤Á¤é¤â 0 ¤è¤êÂ礭¤ÊÃͤǤʤ±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
-¤³¤ì¤é¤Î¥Õ¥£¡¼¥ë¥É¤ËÀßÄê¤Ç¤­¤ëÃͤξå¸Â¤Ï
-.I /proc
-¥Õ¥¡¥¤¥ë¤Ë¤è¤ê·è¤Þ¤ë¡£
-.I /proc
-¥Õ¥¡¥¤¥ë¤Î¾ÜºÙ¤Ï
-.BR mq_open (3)
-¤ËÀâÌÀ¤µ¤ì¤Æ¤¤¤ë¡£
+\fImq_maxmsg\fP と \fImq_msgsize\fP フィールドは \fBmq_open\fP(3)  でメッセージキューが作成される際にセットされる。
+\fImq_maxmsg\fP フィールドは、 \fBmq_send\fP(3)  を使ってキューに入れることができるメッセージ数の上限である。
+\fImq_msgsize\fP フィールドは、キューに入れることができるメッセージの 上限サイズである。 これらのフィールドはどちらも 0
+より大きな値でなければならない。 これらのフィールドに設定できる値の上限は \fI/proc\fP ファイルにより決まる。 \fI/proc\fP ファイルの詳細は
+\fBmq_open\fP(3)  に説明されている。

 
 

-.I mq_curmsgs
-¥Õ¥£¡¼¥ë¥É¤Ï¥­¥å¡¼¤Ë¸½ºß³ÊǼ¤µ¤ì¤Æ¤¤¤ë¥á¥Ã¥»¡¼¥¸¿ô¤òÊÖ¤¹¡£
+\fImq_curmsgs\fP フィールドはキューに現在格納されているメッセージ数を返す。

 
 

-.BR mq_setattr ()
-¤Ï¡¢
-.I newattr
-¤¬»Ø¤¹
-.I mq_attr
-¹½Â¤ÂΤÇÍ¿¤¨¤é¤ì¤¿¾ðÊó¤ò»È¤Ã¤Æ¡¢¥á¥Ã¥»¡¼¥¸¥­¥å¡¼¤Î°À­¤òÀßÄꤹ¤ë¡£
-Êѹ¹¤¹¤ë¤³¤È¤¬¤Ç¤­¤ë°À­¤Ï¡¢
-.I mq_flags
-¤Î
-.B O_NONBLOCK
-¥Õ¥é¥°¤ÎÀßÄê¤À¤±¤Ç¤¢¤ë¡£
-.I newattr
-¤Î¾¤Î¥Õ¥£¡¼¥ë¥É¤Ï̵»ë¤µ¤ì¤ë¡£
-.I oldattr
-¥Õ¥£¡¼¥ë¥É¤¬ NULL °Ê³°¤Î¾ì¹ç¡¢
-.BR mq_getattr ()
-¤¬ÊÖ¤¹¤Î¤ÈƱ¤¸¾ðÊó¤ò³ÊǼ¤·¤¿
-.I mq_attr
-¹½Â¤ÂΤò
-.I oldattr
-¤¬»Ø¤¹¥Ð¥Ã¥Õ¥¡¤ËÆþ¤ì¤ÆÊÖ¤¹¡£
-.SH ÊÖ¤êÃÍ
-À®¸ù¤¹¤ë¤È¡¢
-.I mq_getattr ()
-¤È
-.I mq_setattr ()
-¤Ï 0 ¤òÊÖ¤¹¡£¥¨¥é¡¼¤Î¾ì¹ç¡¢\-1 ¤òÊÖ¤·¡¢
-.I errno
-¤Ë¥¨¥é¡¼¤ò¼¨¤¹ÃͤòÀßÄꤹ¤ë¡£
-.SH ¥¨¥é¡¼
-.TP
-.B EBADF
-.I mqdes
-¤Ç»ØÄꤵ¤ì¤¿µ­½Ò»Ò¤¬ÉÔÀµ¤Ç¤¢¤ë¡£
-.TP
-.B EINVAL
-.I newattr\->mq_flags
-¤Ë
-.B O_NONBLOCK
-°Ê³°¤Î¥Ó¥Ã¥È¤¬¥»¥Ã¥È¤µ¤ì¤Æ¤¤¤¿¡£
-.SH ½àµò
-POSIX.1-2001.
-.SH Ãí°Õ
-Linux ¤Ç¤Ï¡¢
-.BR mq_getattr ()
-¤È
-.BR mq_setattr ()
-¤Ï¥é¥¤¥Ö¥é¥ê´Ø¿ô¤Ç¤¢¤ê¡¢
-.BR mq_getsetattr (2)
-¥·¥¹¥Æ¥à¥³¡¼¥ë¤òÍѤ¤¤Æ¼ÂÁõ¤µ¤ì¤Æ¤¤¤ë¡£
-.SH ´ØÏ¢¹àÌÜ
-.BR mq_close (3),
-.BR mq_notify (3),
-.BR mq_open (3),
-.BR mq_receive (3),
-.BR mq_send (3),
-.BR mq_unlink (3),
-.BR mq_overview (7)
+\fBmq_setattr\fP()  は、 \fInewattr\fP が指す \fImq_attr\fP
+構造体で与えられた情報を使って、メッセージキューの属性を設定する。 変更することができる属性は、 \fImq_flags\fP の \fBO_NONBLOCK\fP
+フラグの設定だけである。 \fInewattr\fP の他のフィールドは無視される。 \fIoldattr\fP フィールドが NULL 以外の場合、
+\fBmq_getattr\fP()  が返すのと同じ情報を格納した \fImq_attr\fP 構造体を \fIoldattr\fP が指すバッファに入れて返す。
+.SH 返り値
+成功すると、 \fImq_getattr ()\fP と \fImq_setattr ()\fP は 0 を返す。エラーの場合、\-1 を返し、 \fIerrno\fP
+にエラーを示す値を設定する。
+.SH エラー
+.TP 
+\fBEBADF\fP
+\fImqdes\fP に指定されたディスクリプタが不正である。
+.TP 
+\fBEINVAL\fP
+\fInewattr\->mq_flags\fP に \fBO_NONBLOCK\fP 以外のビットがセットされていた。
+.SH 準拠
+POSIX.1\-2001.
+.SH 注意
+Linux では、 \fBmq_getattr\fP()  と \fBmq_setattr\fP()  はライブラリ関数であり、
+\fBmq_getsetattr\fP(2)  システムコールを用いて実装されている。
+.SH 関連項目
+\fBmq_close\fP(3), \fBmq_notify\fP(3), \fBmq_open\fP(3), \fBmq_receive\fP(3),
+\fBmq_send\fP(3), \fBmq_unlink\fP(3), \fBmq_overview\fP(7)