share/man/man3picltree/ptree_get_propinfo.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_PROPINFO 3PICLTREE "Mar 28, 2000"
   7 .SH NAME
   8 ptree_get_propinfo \- get property information
   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_propinfo\fR(\fBpicl_prophdl_t\fR \fIproph\fR,
  16      \fBptree_propinfo_t *\fR\fIpi\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBptree_get_propinfo()\fR function gets the information about the property
  23 specified by handle \fIproph\fR and copies it into the location specified by
  24 \fIpi\fR.  See \fBlibpicltree\fR(3PICLTREE) for more information about
  25 \fBptree_propinfo_t\fR structure.
  26 .SH RETURN VALUES
  27 .sp
  28 .LP
  29 Upon successful completion, \fB0\fR is returned. On failure, a non-negative
  30 integer is returned to indicate an error.
  31 .sp
  32 .LP
  33 \fBPICL_STALEHANDLE\fR is returned if the handle is no longer valid. This
  34 occurs if the PICL tree was refreshed or reinitialized.
  35 .sp
  36 .LP
  37 \fBPICL_INVALIDHANDLE\fR is returned if the specified handle never existed.
  38 .SH ERRORS
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBPICL_INVALIDHANDLE\fR\fR
  43 .ad
  44 .RS 22n
  45 Invalid handle
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBPICL_STALEHANDLE\fR\fR
  52 .ad
  53 .RS 22n
  54 Stale handle
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBPICL_NOTPROP\fR\fR
  61 .ad
  62 .RS 22n
  63 Not a property
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBPICL_FAILURE\fR\fR
  70 .ad
  71 .RS 22n
  72 General system failure
  73 .RE
  74
  75 .SH ATTRIBUTES
  76 .sp
  77 .LP
  78 See \fBattributes\fR(5) for descriptions of the following attributes:
  79 .sp
  80
  81 .sp
  82 .TS
  83 box;
  84 c | c
  85 l | l .
  86 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  87 _
  88 Interface Stability     Evolving
  89 _
  90 MT-Level        MT-Safe
  91 .TE
  92
  93 .SH SEE ALSO
  94 .sp
  95 .LP
  96 \fBlibpicltree\fR(3PICLTREE), \fBptree_create_prop\fR(3PICLTREE),
  97 \fBattributes\fR(5)