xref: /illumos-gate/usr/src/man/man3picltree/ptree_get_frutree_parent.3picltree (revision 0aaef2f550fa500248f59b0b8a14225b5afbd198)
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]
PTREE_GET_FRUTREE_PARENT 3PICLTREE "April 9, 2016"
NAME
ptree_get_frutree_parent - get frutree parent node for a given device node
SYNOPSIS

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

int ptree_get_frutree_parent(picl_nodehdl_t devh,
 picl_nodehdl_t *frutreeh);
DESCRIPTION

The devices under the /platform subtree of the PICLTREE are linked to their FRU containers represented in the /frutree using PICL reference properties. The ptree_get_frutree_parent() function returns the handle of the node in the /frutree subtree that is the FRU parent or container of the device specified by the node handle, devh. The handle is returned in the frutreeh argument.

RETURN VALUES

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

ERRORS
PICL_FAILURE

General system failure

PICL_INVALIDHANDLE

Invalid handle

PICL_PROPNOTFOUND

Property not found

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

ptree_get_propinfo(3PICLTREE), ptree_get_propval(3PICLTREE), ptree_get_propval_by_name(3PICLTREE), ptree_get_prop_by_name(3PICLTREE), attributes(5)