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_PROPINFO 3PICL "May 16, 2020"
   7 .SH NAME
   8 picl_get_propinfo \- get the information about a property
   9 .SH SYNOPSIS
  10 .nf
  11 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lpicl\fR [ \fIlibrary\fR... ]
  12 #include <picl.h>
  13 
  14 \fBint\fR \fBpicl_get_propinfo\fR(\fBpicl_prophdl_t\fR \fIproph\fR,
  15      \fBpicl_propinfo_t *\fR\fIpinfo\fR);
  16 .fi
  17 
  18 .SH DESCRIPTION
  19 The \fBpicl_get_propinfo()\fR function gets the information about the property
  20 specified by handle \fIproph\fR and copies it into the location specified by
  21 \fIpinfo\fR.  The property information includes the property type, access mode,
  22 size, and the name of the property as described on \fBlibpicl\fR(3PICL) manual
  23 page.
  24 .sp
  25 .LP
  26 The maximum size of a property value is specified by \fBPICL_PROPSIZE_MAX\fR.
  27 It is currently set to 512KB.
  28 .SH RETURN VALUES
  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 This error may be returned for a previously valid handle if the daemon was
  39 brought down and restarted. When this occurs a client must revalidate any saved
  40 handles.
  41 .SH ERRORS
  42 .ne 2
  43 .na
  44 \fB\fBPICL_NOTINITIALIZED\fR\fR
  45 .ad
  46 .RS 23n
  47 Session not initialized
  48 .RE
  49 
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBPICL_NORESPONSE\fR\fR
  54 .ad
  55 .RS 23n
  56 Daemon not responding
  57 .RE
  58 
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBPICL_NOTPROP\fR\fR
  63 .ad
  64 .RS 23n
  65 Not a property
  66 .RE
  67 
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fBPICL_INVALIDHANDLE\fR\fR
  72 .ad
  73 .RS 23n
  74 Invalid handle specified
  75 .RE
  76 
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBPICL_STALEHANDLE\fR\fR
  81 .ad
  82 .RS 23n
  83 Stale handle specified
  84 .RE
  85 
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBPICL_FAILURE\fR\fR
  90 .ad
  91 .RS 23n
  92 General system failure
  93 .RE
  94 
  95 .SH ATTRIBUTES
  96 See \fBattributes\fR(5) for descriptions of the following attributes:
  97 .sp
  98 
  99 .sp
 100 .TS
 101 box;
 102 c | c
 103 l | l .
 104 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 105 _
 106 MT-Level        MT-Safe
 107 .TE
 108 
 109 .SH SEE ALSO
 110 \fBlibpicl\fR(3PICL), \fBpicl_get_propval\fR(3PICL),
 111 \fBpicl_get_propval_by_name\fR(3PICL), \fBattributes\fR(5)