8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man3nsl / t_sysconf.3nsl
bloba5cfd31d96832f602afd060291720994e4fb7782
1 '\" te
2 .\"  Copyright 1994, The X/Open Company Ltd.  All Rights Reserved  Portions Copyright 1989 AT&T  Portions Copyright (c) 1998, Sun Microsystems, Inc.  All Rights Reserved
3 .\" 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
4 .\" http://www.opengroup.org/bookstore/.
5 .\" 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.
6 .\"  This notice shall appear on any product containing this material.
7 .\" 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.
8 .\" 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.
9 .\" 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]
10 .TH T_SYSCONF 3NSL "May 7, 1998"
11 .SH NAME
12 t_sysconf \- get configurable XTI variables
13 .SH SYNOPSIS
14 .LP
15 .nf
16 #include <xti.h>
20 \fBint\fR \fBt_sysconf\fR(\fBint\fR\fIname\fR);
21 .fi
23 .SH DESCRIPTION
24 .sp
25 .LP
26 The  \fBt_sysconf()\fR function provides a method for the application to
27 determine the current value of configurable and  implementation-dependent XTI
28 limits or options.
29 .sp
30 .LP
31 The  \fIname\fR argument represents the XTI system variable to be queried.  The
32 following table lists the minimal set of XTI system variables from
33 \fB<xti.h>\fR that can be returned by  \fBt_sysconf()\fR, and the symbolic
34 constants, defined in  \fB<xti.h>\fR that are the corresponding values used for
35 \fIname\fR.
36 .sp
38 .sp
39 .TS
40 box;
41 c | c
42 l | l .
43 Variable        Value of Name
45 T_IOV_MAX       _SC_T_IOV_MAX
46 .TE
48 .SH RETURN VALUES
49 .sp
50 .LP
51 If  \fIname\fR is valid,  \fBt_sysconf()\fR returns the value of the requested
52 limit/option, which might be  -1, and leaves  \fBt_errno\fR unchanged.
53 Otherwise, a value of  -1 is returned and  \fBt_errno\fR is set to indicate an
54 error.
55 .SH VALID STATES
56 .sp
57 .LP
58 All.
59 .SH ERRORS
60 .sp
61 .LP
62 On failure,  \fBt_errno\fR is set to the following:
63 .sp
64 .ne 2
65 .na
66 \fB\fBTBADFLAG\fR\fR
67 .ad
68 .RS 12n
69 \fIname\fR has an invalid value.
70 .RE
72 .SH TLI COMPATIBILITY
73 .sp
74 .LP
75 In the \fBTLI\fR interface definition, no counterpart of this routine was
76 defined.
77 .SH ATTRIBUTES
78 .sp
79 .LP
80 See \fBattributes\fR(5) for descriptions of the following attributes:
81 .sp
83 .sp
84 .TS
85 box;
86 c | c
87 l | l .
88 ATTRIBUTE TYPE  ATTRIBUTE VALUE
90 MT-Level        MT-Safe
91 .TE
93 .SH SEE ALSO
94 .sp
95 .LP
96 \fBsysconf\fR(3C), \fBt_rcvv\fR(3NSL), \fBt_rcvvudata\fR(3NSL),
97 \fBt_sndv\fR(3NSL), \fBt_sndvudata\fR(3NSL), \fBattributes\fR(5)