usr/src/man/man3picl/picl_get_next_by_row.3picl

   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 PICL_GET_NEXT_BY_ROW 3PICL "Mar 28, 2000"
   7 .SH NAME
   8 picl_get_next_by_row, picl_get_next_by_col \- access a table property
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpicl\fR [ \fIlibrary\fR... ]
  13 #include <picl.h>
  14
  15 \fBint\fR \fBpicl_get_next_by_row\fR(\fBpicl_prophdl_t\fR \fIproph\fR,
  16      \fBpicl_prophdl_t *\fR\fIcolh\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint\fR \fBpicl_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 \fBpicl_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 \fBpicl_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 This error may be returned for a previously valid handle if the daemon was
  53 brought down and restarted. When this occurs a client must revalidate any saved
  54 handles.
  55 .SH ERRORS
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fBPICL_NOTINITIALIZED\fR\fR
  60 .ad
  61 .RS 23n
  62 Session not initialized
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBPICL_NORESPONSE\fR\fR
  69 .ad
  70 .RS 23n
  71 Daemon not responding
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBPICL_NOTTABLE\fR\fR
  78 .ad
  79 .RS 23n
  80 Not a table
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBPICL_INVALIDHANDLE\fR\fR
  87 .ad
  88 .RS 23n
  89 Invalid handle
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBPICL_STALEHANDLE\fR\fR
  96 .ad
  97 .RS 23n
  98 Stale handle
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBPICL_FAILURE\fR\fR
 105 .ad
 106 .RS 23n
 107 General system failure
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBPICL_ENDOFLIST\fR\fR
 114 .ad
 115 .RS 23n
 116 General system failure
 117 .RE
 118
 119 .SH ATTRIBUTES
 120 .sp
 121 .LP
 122 See \fBattributes\fR(5) for descriptions of the following attributes:
 123 .sp
 124
 125 .sp
 126 .TS
 127 box;
 128 c | c
 129 l | l .
 130 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 131 _
 132 MT-Level        MT-Safe
 133 .TE
 134
 135 .SH SEE ALSO
 136 .sp
 137 .LP
 138 \fBpicl_get_propval\fR(3PICL), \fBattributes\fR(5)