share/man/man3picl/picl_get_root.3picl

   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 PICL_GET_ROOT 3PICL "Mar 28, 2000"
   7 .SH NAME
   8 picl_get_root \- get the root handle of the PICL tree
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpicl\fR [ \fIlibrary\fR... ]
  13 #include <picl.h>
  14
  15 \fBint\fR \fBpicl_get_root\fR(\fBpicl_nodehdl_t *\fR\fInodehandle\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBpicl_get_root()\fR function gets the handle of the root node of the PICL
  22 tree and copies it into the location given by \fInodehandle\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_NOTINITIALIZED\fR\fR
  33 .ad
  34 .RS 23n
  35 Session not initialized
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBPICL_NORESPONSE\fR\fR
  42 .ad
  43 .RS 23n
  44 Daemon not responding
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBPICL_FAILURE\fR\fR
  51 .ad
  52 .RS 23n
  53 General system failure
  54 .RE
  55
  56 .SH ATTRIBUTES
  57 .sp
  58 .LP
  59 See \fBattributes\fR(5)  for descriptions of the following attributes:
  60 .sp
  61
  62 .sp
  63 .TS
  64 box;
  65 c | c
  66 l | l .
  67 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  68 _
  69 MT-Level        MT-Safe
  70 .TE
  71
  72 .SH SEE ALSO
  73 .sp
  74 .LP
  75 \fBpicl_initialize\fR(3PICL), \fBpicl_shutdown\fR(3PICL), \fBattributes\fR(5)