share/man/man3picltree/ptree_get_frutree_parent.3picltree

   1 '\" te
   2 .\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH PTREE_GET_FRUTREE_PARENT 3PICLTREE "April 9, 2016"
   7 .SH NAME
   8 ptree_get_frutree_parent \- get frutree parent node for a given device node
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lpicltree\fR [ \fIlibrary\fR\&.\|.\|. ]
  13 #include <picltree.h>
  14
  15 \fBint\fR \fBptree_get_frutree_parent\fR(\fBpicl_nodehdl_t\fR \fIdevh\fR,
  16      \fBpicl_nodehdl_t *\fR\fIfrutreeh\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .LP
  21 The devices under the \fB/platform\fR subtree of the PICLTREE are linked to
  22 their FRU containers represented in the \fB/frutree\fR using PICL reference
  23 properties. The \fBptree_get_frutree_parent()\fR function returns the handle of
  24 the node in the \fB/frutree\fR subtree that is the FRU parent or container of
  25 the device specified by the node handle, \fIdevh\fR. The handle is returned
  26 in the \fIfrutreeh\fR argument.
  27 .SH RETURN VALUES
  28 .LP
  29 Upon successful completion, 0 is returned. Otherwise a non-negative integer is
  30 returned to indicate an error.
  31 .SH ERRORS
  32 .ne 2
  33 .na
  34 \fB\fBPICL_FAILURE\fR\fR
  35 .ad
  36 .RS 22n
  37 General system failure
  38 .RE
  39
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fBPICL_INVALIDHANDLE\fR\fR
  44 .ad
  45 .RS 22n
  46 Invalid handle
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBPICL_PROPNOTFOUND\fR\fR
  53 .ad
  54 .RS 22n
  55 Property not found
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBPICL_STALEHANDLE\fR\fR
  62 .ad
  63 .RS 22n
  64 Stale handle
  65 .RE
  66
  67 .SH ATTRIBUTES
  68 .LP
  69 See \fBattributes\fR(5) for descriptions of the following attributes:
  70 .sp
  71
  72 .sp
  73 .TS
  74 box;
  75 c | c
  76 l | l .
  77 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  78 _
  79 Interface Stability     Evolving
  80 _
  81 MT-Level        MT-Safe
  82 .TE
  83
  84 .SH SEE ALSO
  85 .LP
  86 \fBptree_get_propinfo\fR(3PICLTREE), \fBptree_get_propval\fR(3PICLTREE),
  87 \fBptree_get_propval_by_name\fR(3PICLTREE),
  88 \fBptree_get_prop_by_name\fR(3PICLTREE), \fBattributes\fR(5)