share/man/man3picl/picl_get_prop_by_name.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_PROP_BY_NAME 3PICL "Mar 28, 2000"
   7 .SH NAME
   8 picl_get_prop_by_name \- get the handle of the property by name
   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_prop_by_name\fR(\fBpicl_nodehdl_t\fR \fInodeh\fR, \fBchar *\fR\fIname\fR,
  16      \fBpicl_prophdl_t *\fR\fIproph\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBpicl_get_prop_by_name()\fR function gets the handle of the property of
  23 node \fInodeh\fR whose name is specified in \fIname\fR. The handle is copied
  24 into the location specified by \fIproph\fR.
  25 .SH RETURN VALUES
  26 .sp
  27 .LP
  28 Upon successful completion, \fB0\fR is returned. On failure, a non-negative
  29 integer is returned to indicate an error.
  30 .sp
  31 .LP
  32 \fBPICL_PROPNOTFOUND\fR is returned if the property of the specified name does
  33 not exist.
  34 .sp
  35 .LP
  36 \fBPICL_RESERVEDNAME\fR is returned if the property name specified is one of
  37 the reserved property names.
  38 .sp
  39 .LP
  40 \fBPICL_STALEHANDLE\fR is returned if the handle is no longer valid. This
  41 occurs if the PICL tree was refreshed or reinitialized.
  42 .sp
  43 .LP
  44 \fBPICL_INVALIDHANDLE\fR is returned if the specified handle never existed.
  45 This error may be returned for a previously valid handle if the daemon was
  46 brought down and restarted. When this occurs a client must revalidate any saved
  47 handles.
  48 .SH ERRORS
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBPICL_NOTINITIALIZED\fR\fR
  53 .ad
  54 .RS 23n
  55 Session not initialized
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBPICL_NORESPONSE\fR\fR
  62 .ad
  63 .RS 23n
  64 Daemon not responding
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBPICL_NOTNODE\fR\fR
  71 .ad
  72 .RS 23n
  73 Not a node
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBPICL_PROPNOTFOUND\fR\fR
  80 .ad
  81 .RS 23n
  82 Property not found
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBPICL_RESERVEDNAME\fR\fR
  89 .ad
  90 .RS 23n
  91 Reserved property name specified
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fBPICL_INVALIDHANDLE\fR\fR
  98 .ad
  99 .RS 23n
 100 Invalid handle
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBPICL_STALEHANDLE\fR\fR
 107 .ad
 108 .RS 23n
 109 Stale handle
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fBPICL_FAILURE\fR\fR
 116 .ad
 117 .RS 23n
 118 General system failure
 119 .RE
 120
 121 .SH ATTRIBUTES
 122 .sp
 123 .LP
 124 See \fBattributes\fR(5) for descriptions of the following attributes:
 125 .sp
 126
 127 .sp
 128 .TS
 129 box;
 130 c | c
 131 l | l .
 132 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 133 _
 134 MT-Level        MT-Safe
 135 .TE
 136
 137 .SH SEE ALSO
 138 .sp
 139 .LP
 140 \fBattributes\fR(5)