usr/src/man/man3picltree/ptree_init_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_INIT_PROPINFO 3PICLTREE "Aug 1, 2000"
   7 .SH NAME
   8 ptree_init_propinfo \- initialize ptree_propinfo_t structure
   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_init_propinfo\fR(\fBptree_propinfo_t *\fR\fIinfop\fR, \fBint\fR \fIversion\fR,
  16      \fBint\fR \fIptype\fR, \fBint\fR \fIpmode\fR, \fBsize_t\fR \fIpsize\fR, \fBchar *\fR\fIpname\fR,
  17      \fBint (*\fR\fIreadfn\fR)(ptree_rarg_t *, \fBvoid *)\fR,
  18      \fBint (*\fR\fIwritefn\fR)(ptree_warg_t *, \fBconst void *)\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBptree_init_propinfo()\fR function initializes a \fBptree_propinfo_t\fR
  25 property information structure given by location \fIinfop\fR with the values
  26 provided by the arguments.
  27 .sp
  28 .LP
  29 The \fIversion\fR argument specifies the version of the \fBptree_propinfo_t\fR
  30 structure. \fBPTREE_PROPINFO_VERSION\fR gives the current version. The
  31 arguments \fIptype\fR, \fIpmode\fR, \fIpsize\fR, and \fIpname\fR specify the
  32 property's PICL type, access mode, size, and name. The maximum size of a
  33 property name is defined by \fBPICL_PROPNAMELEN_MAX\fR. The arguments
  34 \fIreadfn\fR and \fIwritefn\fR specify a volatile property's read and write
  35 access functions. For non-volatile properties, these are set to \fINULL\fR.
  36 .SH RETURN VALUES
  37 .sp
  38 .LP
  39 Upon successful completion, \fB0\fR is returned. On failure, a non-negative
  40 integer is returned to indicate an error.
  41 .SH ERRORS
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fBPICL_INVALIDARG\fR\fR
  46 .ad
  47 .RS 21n
  48 Invalid argument
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBPICL_NOTSUPPORTED\fR\fR
  55 .ad
  56 .RS 21n
  57 Property version not supported
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBPICL_FAILURE\fR\fR
  64 .ad
  65 .RS 21n
  66 General system failure
  67 .RE
  68
  69 .SH ATTRIBUTES
  70 .sp
  71 .LP
  72 See \fBattributes\fR(5) for descriptions of the following attributes:
  73 .sp
  74
  75 .sp
  76 .TS
  77 box;
  78 c | c
  79 l | l .
  80 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  81 _
  82 Interface Stability     Evolving
  83 _
  84 MT-Level        MT-Safe
  85 .TE
  86
  87 .SH SEE ALSO
  88 .sp
  89 .LP
  90 \fBptree_get_propinfo\fR(3PICLTREE), \fBattributes\fR(5)