'\" te
.\" Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved.
.\" 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.
.\" 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.
.\" 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]
.TH picl_get_next_by_row 3PICL "28 Mar 2000" "SunOS 5.11" "PICL Library Functions"
.SH NAME
picl_get_next_by_row, picl_get_next_by_col \- access a table property
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpicl\fR [ \fIlibrary\fR... ] 
#include <picl.h>

\fBint\fR \fBpicl_get_next_by_row\fR(\fBpicl_prophdl_t\fR \fIproph\fR,
     \fBpicl_prophdl_t *\fR\fIcolh\fR);
.fi

.LP
.nf
\fBint\fR \fBpicl_get_next_by_col\fR(\fBpicl_prophdl_t\fR \fIproph\fR,
     \fBpicl_prophdl_t *\fR\fIcolh\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBpicl_get_next_by_row()\fR function copies the handle of the property
that is in the next column of the table and on the same row as the property
\fIproph\fR. The handle is copied into the location given by \fIrowh\fR.
.sp
.LP
The \fBpicl_get_next_by_col()\fR function copies the handle of the property
that is in the next row of the table and on the same column as the property
\fIproph\fR. The handle is copied into the location given by \fIcolh\fR.
.sp
.LP
If there are no more rows or columns, this function returns the value
\fBPICL_ENDOFLIST\fR.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, \fB0\fR is returned. On failure, a non-negative
integer is returned to indicate an error.
.sp
.LP
\fBPICL_STALEHANDLE\fR is returned if the handle is no longer valid. This
occurs if the PICL tree was refreshed or reinitialized.
.sp
.LP
\fBPICL_INVALIDHANDLE\fR is returned if the specified handle never existed.
This error may be returned for a previously valid handle if the daemon was
brought down and restarted. When this occurs a client must revalidate any saved
handles.
.SH ERRORS
.sp
.ne 2
.mk
.na
\fB\fBPICL_NOTINITIALIZED\fR\fR
.ad
.RS 23n
.rt  
Session not initialized
.RE

.sp
.ne 2
.mk
.na
\fB\fBPICL_NORESPONSE\fR\fR
.ad
.RS 23n
.rt  
Daemon not responding
.RE

.sp
.ne 2
.mk
.na
\fB\fBPICL_NOTTABLE\fR\fR
.ad
.RS 23n
.rt  
Not a table
.RE

.sp
.ne 2
.mk
.na
\fB\fBPICL_INVALIDHANDLE\fR\fR
.ad
.RS 23n
.rt  
Invalid handle
.RE

.sp
.ne 2
.mk
.na
\fB\fBPICL_STALEHANDLE\fR\fR
.ad
.RS 23n
.rt  
Stale handle
.RE

.sp
.ne 2
.mk
.na
\fB\fBPICL_FAILURE\fR\fR
.ad
.RS 23n
.rt  
General system failure
.RE

.sp
.ne 2
.mk
.na
\fB\fBPICL_ENDOFLIST\fR\fR
.ad
.RS 23n
.rt  
General system failure
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBpicl_get_propval\fR(3PICL), \fBattributes\fR(5)