putctl.9

7号信令功能代码,为开源代码

'\" tr
.\" -*- nroff -*-
.\"
.\" @(#) putctl.9,v 1.1.4.1 2004/01/12 23:33:09 brian Exp
.\"
.\" =========================================================================
.\"
.\" Copyright (C) 2001-2004  OpenSS7 Corp. <www.openss7.com>
.\"
.\" All Rights Reserved.
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\" 
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\" 
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" =========================================================================
.\"
.\" Modified 2004/01/12 23:33:09 by brian
.\"
.\" =========================================================================
.so lis.macros
.R1
bracket-label "\fR[\fB" "\fR]" "\fR, \fB"
no-default-database
database lis.refs
accumulate
move-punctuation
abbreviate A
join-authors ", " ", " " and "
et-al " et al" 2 3
abbreviate-label-ranges ".."
sort-adjacent-labels
.R2
.\"
.\"
.TH PUTCTL 9 "2004/01/12 23:33:09" "LiS-2_16_18-8" "Linux STREAMS DDI/DKI"
.SH NAME
.B putctl, lis_putctl
\- puts a control message on a \fISTREAMS\fR message queue
.SH SYNOPSIS
.PP
.B #include <sys/stream.h>
.HP 8
.BI "int " retval " = putctl(queue_t *" q ", int " type );
.SH DESCRIPTION
.PP
.BR putctl ()
creates a zero-length control message of type
.I type
and invokes the put procedure of the queue pointed to by
.I q
to place the message on the queue.
If
.I type
is a data message type and not a control message type,
.BR putctl ()
will fail.
.SH "RETURN VALUES"
.PP
Upon success,
.BR putctl ()
returns true (1).
.PP
Upon failure,
.BR putctl ()
returns false (0).
.SH ERRORS
.PP
.BR putctl ()
fails and returns false (0) if the specified
.I type
is not a control message type, or if the passed in queue pointer
.I q
is
.BR NULL ;
or, if allocation of the necessary message block fails.
.SH CAVEATS
.PP
None.
.SH BUGS
.PP
.B LiS
.[
LiS
.]
.BR putctl ()
will return success even if the operation fails because of the following
conditions:
.I q
is not
.BR NULL ,
but points to something other than a queue structure;
the queue pointed to by
.I q
has a
.I q_info
pointer of
.BR NULL ;
the queue pointed to by
.I q
has no put procedure; or the queue pointed to by
.I q
is closing, or the queue has had put and service routine processing turned off
(e.g. with
.BR qprocsoff (9)).
.B LiS
.[
LiS
.]
should return failure when the operation fails.
.SH "SEE ALSO"
.PP
.BR putctl1 (9),
.BR putnextctl (9),
.BR putnextctl1 (9).
.SH VERSIONS
.PP
This manpage was written for
.B LiS\c
.
.[
LiS
.]
.\"
.\"
.XX
.[
magic
.]
.[
svr42
.]
.[
svr4
.]
.\"
.\"
.[
$LIST$
.]
.TA