usr/src/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 "Feb 5, 2004"
   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 .sp
  21 .LP
  22 The devices under the \fB/platform\fR subtree of the PICLTREE are linked to
  23 their FRU containers represented in the \fB/frutree\fR using PICL reference
  24 properties. The \fBptree_get_frutree_parent()\fR function returns the handle of
  25 the node in the \fB/frutree\fR subtree that is the FRU parent or container of
  26 the the device specified by the node handle, \fIdevh\fR. The handle is returned
  27 in the \fIfrutreeh\fR argument.
  28 .SH RETURN VALUES
  29 .sp
  30 .LP
  31 Upon successful completion, 0 is returned. Otherwise a non-negative integer is
  32 returned to indicate an error.
  33 .SH ERRORS
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fBPICL_FAILURE\fR\fR
  38 .ad
  39 .RS 22n
  40 General system failure
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBPICL_INVALIDHANDLE\fR\fR
  47 .ad
  48 .RS 22n
  49 Invalid handle
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBPICL_PROPNOTFOUND\fR\fR
  56 .ad
  57 .RS 22n
  58 Property not found
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBPICL_STALEHANDLE\fR\fR
  65 .ad
  66 .RS 22n
  67 Stale handle
  68 .RE
  69
  70 .SH ATTRIBUTES
  71 .sp
  72 .LP
  73 See \fBattributes\fR(5) for descriptions of the following attributes:
  74 .sp
  75
  76 .sp
  77 .TS
  78 box;
  79 c | c
  80 l | l .
  81 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  82 _
  83 Interface Stability     Evolving
  84 _
  85 MT-Level        MT-Safe
  86 .TE
  87
  88 .SH SEE ALSO
  89 .sp
  90 .LP
  91 \fBptree_get_propinfo\fR(3PICLTREE), \fBptree_get_propval\fR(3PICLTREE),
  92 \fBptree_get_propval_by_name\fR(3PICLTREE),
  93 \fBptree_get_prop_by_name\fR(3PICLTREE), \fBattributes\fR(5)