PTREE_GET_NEXT_BY_ROW(3PICLTREE) PICL Plug-In Library Functions

NAME

ptree_get_next_by_row, ptree_get_next_by_col - access a table
property

SYNOPSIS

cc [ flag... ] file... -lpicltree [ library... ]
#include <picltree.h>

int ptree_get_next_by_row(picl_prophdl_t proph,
picl_prophdl_t *rowh);


int ptree_get_next_by_col(picl_prophdl_t proph,
picl_prophdl_t *colh);

DESCRIPTION

The ptree_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 ptree_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.

ERRORS

PICL_NOTTABLE
Not a table


PICL_INVALIDHANDLE
Invalid handle


PICL_STALEHANDLE
Stale handle


PICL_ENDOFLIST
End of list


PICL_FAILURE
General system failure

ATTRIBUTES

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


+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Evolving |
+--------------------+-----------------+
|MT-Level | MT-Safe |
+--------------------+-----------------+

SEE ALSO

ptree_create_table(3PICLTREE), attributes(7)

March 28, 2000
PTREE_GET_NEXT_BY_ROW(3PICLTREE)