share/man/man3picltree/ptree_get_root.3picltree

   1 '\" te
   2 .\" Copyright (c) 2000, 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_ROOT 3PICLTREE "Mar 28, 2000"
   7 .SH NAME
   8 ptree_get_root \- get the root node handle
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpicltree\fR [ \fIlibrary\fR... ]
  13 #include <picltree.h>
  14
  15 \fBint\fR \fBptree_get_root\fR(\fBpicl_nodehdl_t *\fR\fInodeh\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBptree_get_root()\fR function copies the handle of the root node of the
  22 PICL tree into the location specified by \fInodeh\fR.
  23 .SH RETURN VALUES
  24 .sp
  25 .LP
  26 Upon successful completion, \fB0\fR is returned. On failure, a non-negative
  27 integer is returned to indicate an error.
  28 .SH ERRORS
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fBPICL_INVALIDARG\fR\fR
  33 .ad
  34 .RS 19n
  35 Invalid argument
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBPICL_FAILURE\fR\fR
  42 .ad
  43 .RS 19n
  44 General system failure
  45 .RE
  46
  47 .SH ATTRIBUTES
  48 .sp
  49 .LP
  50 See \fBattributes\fR(5) for descriptions of the following attributes:
  51 .sp
  52
  53 .sp
  54 .TS
  55 box;
  56 c | c
  57 l | l .
  58 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  59 _
  60 Interface Stability     Evolving
  61 _
  62 MT-Level        MT-Safe
  63 .TE
  64
  65 .SH SEE ALSO
  66 .sp
  67 .LP
  68 \fBlibpicltree\fR(3PICLTREE), \fBptree_create_node\fR(3PICLTREE),
  69 \fBattributes\fR(5)