xref: /illumos-gate/usr/src/man/man3picl/picl_get_next_by_row.3picl (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
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]
PICL_GET_NEXT_BY_ROW 3PICL "Mar 28, 2000"
NAME
picl_get_next_by_row, picl_get_next_by_col - access a table property
SYNOPSIS

cc [ flag... ] file... -lpicl [ library... ]
#include <picl.h>

int picl_get_next_by_row(picl_prophdl_t proph,
 picl_prophdl_t *colh);

int picl_get_next_by_col(picl_prophdl_t proph,
 picl_prophdl_t *colh);
DESCRIPTION

The picl_get_next_by_row() function copies the handle of the property that is in the next column of the table and on the same row as the property proph. The handle is copied into the location given by rowh.

The picl_get_next_by_col() function copies the handle of the property that is in the next row of the table and on the same column as the property proph. The handle is copied into the location given by colh.

If there are no more rows or columns, this function returns the value PICL_ENDOFLIST.

RETURN VALUES

Upon successful completion, 0 is returned. On failure, a non-negative integer is returned to indicate an error.

PICL_STALEHANDLE is returned if the handle is no longer valid. This occurs if the PICL tree was refreshed or reinitialized.

PICL_INVALIDHANDLE 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.

ERRORS
PICL_NOTINITIALIZED

Session not initialized

PICL_NORESPONSE

Daemon not responding

PICL_NOTTABLE

Not a table

PICL_INVALIDHANDLE

Invalid handle

PICL_STALEHANDLE

Stale handle

PICL_FAILURE

General system failure

PICL_ENDOFLIST

General system failure

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level MT-Safe
SEE ALSO

picl_get_propval (3PICL), attributes (7)