share/man/man3picltree/ptree_create_table.3picltree

   1 '\" te
   2 .\" Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH PTREE_CREATE_TABLE 3PICLTREE "Mar 28, 2000"
   7 .SH NAME
   8 ptree_create_table, ptree_add_row_to_table \- create a table object
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpicltree\fR [ \fIlibrary\fR... ]
  13 #include <picltree.h>
  14
  15 \fBint\fR \fBptree_create_table\fR(\fBpicl_prophdl_t *\fR\fItbl_hdl\fR);
  16 .fi
  17
  18 .LP
  19 .nf
  20 \fBint\fR \fBptree_add_row_to_table\fR(\fBpicl_prophdl_t\fR \fItbl_hdl\fR, \fBint\fR \fInprops\fR,
  21      \fBpicl_prophdl_t *\fR\fIproph\fR);
  22 .fi
  23
  24 .SH DESCRIPTION
  25 .sp
  26 .LP
  27 The \fBptree_create_table()\fR function creates a table object and returns the
  28 handle of the table in \fItbl_hdl\fR.
  29 .sp
  30 .LP
  31 The \fBptree_add_row_to_table()\fR function adds a row of properties to the
  32 table specified by \fItbl_hdl\fR. The handles of the properties of the row are
  33 specified in the \fIproph\fR array and \fInprops\fR specifies the number of
  34 handles in the array. The number of columns in the table is determined from the
  35 first row added to the table. If extra column values are specified in
  36 subsequent rows, they are ignored. The row is appended to the end of the table.
  37 .SH RETURN VALUES
  38 .sp
  39 .LP
  40 Upon successful completion, \fB0\fR is returned. On failure, a non-negative
  41 integer is returned to indicate an error.
  42 .sp
  43 .LP
  44 \fBPICL_STALEHANDLE\fR is returned if the handle is no longer valid. This
  45 occurs if the PICL tree was refreshed or reinitialized.
  46 .sp
  47 .LP
  48 \fBPICL_INVALIDHANDLE\fR is returned if the specified handle never existed.
  49 .SH ERRORS
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBPICL_INVALIDARG\fR\fR
  54 .ad
  55 .RS 22n
  56 Invalid argument
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBPICL_NOTPROP\fR\fR
  63 .ad
  64 .RS 22n
  65 Not a property
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBPICL_NOTTABLE\fR\fR
  72 .ad
  73 .RS 22n
  74 Not a table
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBPICL_INVALIDHANDLE\fR\fR
  81 .ad
  82 .RS 22n
  83 Invalid handle
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBPICL_STALEHANDLE\fR\fR
  90 .ad
  91 .RS 22n
  92 Stale handle
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBPICL_FAILURE\fR\fR
  99 .ad
 100 .RS 22n
 101 General system failure
 102 .RE
 103
 104 .SH ATTRIBUTES
 105 .sp
 106 .LP
 107 See \fBattributes\fR(5) for descriptions of the following attributes:
 108 .sp
 109
 110 .sp
 111 .TS
 112 box;
 113 c | c
 114 l | l .
 115 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 116 _
 117 Interface Stability     Evolving
 118 _
 119 MT-Level        MT-Safe
 120 .TE
 121
 122 .SH SEE ALSO
 123 .sp
 124 .LP
 125 \fBattributes\fR(5)