xref: /illumos-gate/usr/src/man/man3picl/picl_find_node.3picl (revision 4f364e7c95ee7fd9d5bbeddc1940e92405bb0e72)
te
Copyright (c) 2004, 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_FIND_NODE 3PICL "Feb 5, 2004"
NAME
picl_find_node - find node with given property and value
SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -l [ library.\|.\|. ]
#include <picl.h>

int picl_find_node(picl_nodehdl_trooth, char *pname,
 picl_prop_type_t ptype, void *pval, size_t valsize,
 picl_nodehdl_t *retnodeh);
DESCRIPTION

The picl_find_node() function visits the nodes in the subtree under the node specified by rooth. The handle of the node that has the property whose name, type, and value matches the name, type, and value specified in pname, ptype, and pval respectively, is returned in the location given by retnodeh. The valsize argument specifies the size of the value in pval. The first valsize number of bytes of the property value is compared with pval.

RETURN VALUES

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

The value PICL_NODENOTFOUND is returned if no node that matches the property criteria can be found.

ERRORS
PICL_FAILURE

General system failure

PICL_INVALIDHANDLE

Invalid handle

PICL_NODENOTFOUND

Node not found

PICL_NOTNODE

Not a node

PICL_STALEHANDLE

Stale handle

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
MT-Level MT-Safe
SEE ALSO

picl_get_propinfo(3PICL), picl_get_propval(3PICL), picl_get_propval_by_name(3PICL), picl_get_prop_by_name(3PICL), attributes(5)