xref: /illumos-gate/usr/src/man/man3picl/picl_get_first_prop.3picl (revision d2a70789f056fc6c9ce3ab047b52126d80b0e3da)
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_FIRST_PROP 3PICL "Mar 28, 2000"
NAME
picl_get_first_prop, picl_get_next_prop - get a property handle of a node
SYNOPSIS

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

int picl_get_first_prop(picl_nodehdl_t nodeh,
 piclprop_hdl_t *proph);

int picl_get_next_prop(picl_prophdl_t proph,
 picl_prophdl_t *nextprop);
DESCRIPTION

The picl_get_first_prop() function gets the handle of the first property of the node specified by nodeh and copies it into the location given by proph.

The picl_get_next_prop() function gets the handle of the next property after the one specified by proph from the property list of the node, and copies it into the location specified by nextprop.

If there are no more properties, this function returns PICL_ENDOFLIST.

RETURN VALUES

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

PICL_ENDOFLIST is returned to indicate that there are no more properties.

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_NOTNODE

Not a node

PICL_NOTPROP

Not a property

PICL_INVALIDHANDLE

Invalid handle

PICL_STALEHANDLE

Stale handle

PICL_FAILURE

General system failure

PICL_ENDOFLIST

End of list

ATTRIBUTES

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

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

picl_get_prop_by_name(3PICL), attributes(5)