share/man/man3picltree/ptree_get_next_by_row.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_GET_NEXT_BY_ROW 3PICLTREE "Mar 28, 2000"
   7 .SH NAME
   8 ptree_get_next_by_row, ptree_get_next_by_col \- access a table property
   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_get_next_by_row\fR(\fBpicl_prophdl_t\fR \fIproph\fR,
  16      \fBpicl_prophdl_t *\fR\fIrowh\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint\fR \fBptree_get_next_by_col\fR(\fBpicl_prophdl_t\fR \fIproph\fR,
  22      \fBpicl_prophdl_t *\fR\fIcolh\fR);
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .sp
  27 .LP
  28 The \fBptree_get_next_by_row()\fR function copies the handle of the property
  29 that is in the next column of the table and on the same row as the property
  30 \fIproph\fR. The handle is copied into the location given by \fIrowh\fR.
  31 .sp
  32 .LP
  33 The \fBptree_get_next_by_col()\fR function copies the handle of the property
  34 that is in the next row of the table and on the same column as the property
  35 \fIproph\fR. The handle is copied into the location given by \fIcolh\fR.
  36 .sp
  37 .LP
  38 If there are no more rows or columns, this function returns the value
  39 \fBPICL_ENDOFLIST\fR.
  40 .SH RETURN VALUES
  41 .sp
  42 .LP
  43 Upon successful completion, \fB0\fR is returned. On failure, a non-negative
  44 integer is returned to indicate an error.
  45 .sp
  46 .LP
  47 \fBPICL_STALEHANDLE\fR is returned if the handle is no longer valid. This
  48 occurs if the PICL tree was refreshed or reinitialized.
  49 .sp
  50 .LP
  51 \fBPICL_INVALIDHANDLE\fR is returned if the specified handle never existed.
  52 .SH ERRORS
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBPICL_NOTTABLE\fR\fR
  57 .ad
  58 .RS 22n
  59 Not a table
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBPICL_INVALIDHANDLE\fR\fR
  66 .ad
  67 .RS 22n
  68 Invalid handle
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBPICL_STALEHANDLE\fR\fR
  75 .ad
  76 .RS 22n
  77 Stale handle
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBPICL_ENDOFLIST\fR\fR
  84 .ad
  85 .RS 22n
  86 End of list
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fBPICL_FAILURE\fR\fR
  93 .ad
  94 .RS 22n
  95 General system failure
  96 .RE
  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 Interface Stability     Evolving
 112 _
 113 MT-Level        MT-Safe
 114 .TE
 115
 116 .SH SEE ALSO
 117 .sp
 118 .LP
 119 \fBptree_create_table\fR(3PICLTREE), \fBattributes\fR(5)