share/man/man3devinfo/di_node_private_set.3devinfo

   1 '\" te
   2 .\" Copyright (c) 2008, 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 DI_NODE_PRIVATE_SET 3DEVINFO "May 15, 2008"
   7 .SH NAME
   8 di_node_private_set, di_node_private_get, di_path_private_set,
   9 di_path_private_get, di_minor_private_set, di_minor_private_get,
  10 di_link_private_set, di_link_private_get, di_lnode_private_set,
  11 di_lnode_private_get \- manipulate libdevinfo user traversal pointers
  12 .SH SYNOPSIS
  13 .LP
  14 .nf
  15 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-ldevinfo\fR [ \fIlibrary\fR\&.\|.\|. ]
  16 #include <libdevinfo.h>
  17
  18 \fBvoid\fR \fBdi_node_private_set\fR(\fBdi_node_t\fR \fInode\fR, \fBvoid *\fR\fIdata\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBvoid *\fR\fBdi_node_private_get\fR(\fBdi_node_t\fR \fInode\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBvoid\fR \fBdi_path_private_set\fR(\fBdi_path_t\fR \fIpath\fR, \fBvoid *\fR\fIdata\fR);
  29 .fi
  30
  31 .LP
  32 .nf
  33 \fBvoid *\fR\fBdi_path_private_get\fR(\fBdi_path_t\fR \fIpath\fR);
  34 .fi
  35
  36 .LP
  37 .nf
  38 \fBvoid\fR \fBdi_minor_private_set\fR(\fBdi_minor_t\fR \fIminor\fR, \fBvoid *\fR\fIdata\fR);
  39 .fi
  40
  41 .LP
  42 .nf
  43 \fBvoid *\fR\fBdi_minor_private_get\fR(\fBdi_minor_t\fR \fIminor\fR);
  44 .fi
  45
  46 .LP
  47 .nf
  48 \fBvoid\fR \fBdi_link_private_set\fR(\fBdi_link_t\fR \fIlink\fR, \fBvoid *\fR\fIdata\fR);
  49 .fi
  50
  51 .LP
  52 .nf
  53 \fBvoid *\fR\fBdi_link_private_get\fR(\fBdi_link_t\fR \fIlink\fR);
  54 .fi
  55
  56 .LP
  57 .nf
  58 \fBvoid\fR \fBdi_lnode_private_set\fR(\fBdi_lnode_t\fR \fIlnode\fR, \fBvoid *\fR\fIdata\fR);
  59 .fi
  60
  61 .LP
  62 .nf
  63 \fBvoid *\fR\fBdi_lnode_private_get\fR(\fBdi_lnode_t\fR \fIlnode\fR);
  64 .fi
  65
  66 .SH PARAMETERS
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fInode\fR\fR
  71 .ad
  72 .RS 9n
  73 The handle to a devinfo node in a \fBdi_init\fR(3DEVINFO) snapshot.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fIpath\fR\fR
  80 .ad
  81 .RS 9n
  82 The handle to a path node in a snapshot.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fIminor\fR\fR
  89 .ad
  90 .RS 9n
  91 The handle to a minor node in a snapshot.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fIlink\fR\fR
  98 .ad
  99 .RS 9n
 100 The handle to a link in a snapshot.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fIlnode\fR\fR
 107 .ad
 108 .RS 9n
 109 The handle to an lnode in a snapshot.
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fIdata\fR\fR
 116 .ad
 117 .RS 9n
 118 A pointer to caller-specific data.
 119 .RE
 120
 121 .SH DESCRIPTION
 122 .sp
 123 .LP
 124 The \fBdi_node_private_set()\fR function allows a caller to associate
 125 caller-specific data pointed to by \fIdata\fR with a devinfo node, thereby
 126 facilitating traversal of devinfo nodes in the snapshot.
 127 .sp
 128 .LP
 129 The \fBdi_node_private_get()\fR function allows a caller to retrieve a data
 130 pointer that was associated with a devinfo node obtained by a call to
 131 \fBdi_node_private_set()\fR.
 132 .sp
 133 .LP
 134 The \fBdi_path_private_set()\fR function allows a caller to associate
 135 caller-specific data pointed to by \fIdata\fR with a devinfo path node, thereby
 136 facilitating traversal of path nodes in the snapshot.
 137 .sp
 138 .LP
 139 The  \fBdi_path_private_get()\fRfunction allows a caller to retrieve a data
 140 pointer that was associated with a path node obtained by a call to
 141 \fBdi_path_private_set()\fR.
 142 .sp
 143 .LP
 144 The \fBdi_minor_private_set()\fR function allows a caller to associate
 145 caller-specific data pointed to by \fIdata\fR with a minor node specified by
 146 \fIminor\fR, thereby facilitating traversal of minor nodes in the snapshot.
 147 .sp
 148 .LP
 149 The \fBdi_minor_private_get()\fR function allows a caller to retrieve a data
 150 pointer that was associated with a minor node obtained by a call to
 151 \fBdi_minor_private_set()\fR.
 152 .sp
 153 .LP
 154 The \fBdi_link_private_set()\fR function allows a caller to associate
 155 caller-specific data pointed to by \fIdata\fR with a link, thereby facilitating
 156 traversal of links in the snapshot.
 157 .sp
 158 .LP
 159 The \fBdi_link_private_get()\fR function allows a caller to retrieve a data
 160 pointer that was associated with a link obtained by a call to
 161 \fBdi_link_private_set()\fR.
 162 .sp
 163 .LP
 164 The \fBdi_lnode_private_set()\fR function allows a caller to associate
 165 caller-specific data pointed to by \fIdata\fR with an lnode specified by
 166 \fIlnode\fR, thereby facilitating traversal of lnodes in the snapshot.
 167 .sp
 168 .LP
 169 The \fBdi_lnode_private_get()\fR function allows a caller to retrieve a data
 170 pointer that was associated with an lnode by a call to
 171 \fBdi_lnode_private_set()\fR.
 172 .sp
 173 .LP
 174 These functions do not perform any type of locking. It is up to the caller to
 175 satisfy any locking needs.
 176 .SH RETURN VALUES
 177 .sp
 178 .LP
 179 The \fBdi_node_private_set()\fR, \fBdi_path_private_set()\fR,
 180 \fBdi_minor_private_set()\fR, \fBdi_link_private_set()\fR, and
 181 \fBdi_lnode_private_set()\fR functions do not return values.
 182 .sp
 183 .LP
 184 The \fBdi_node_private_get()\fR, \fBdi_path_private_get()\fR,
 185 \fBdi_minor_private_get()\fR, \fBdi_link_private_get()\fR, and
 186 \fBdi_lnode_private_get()\fR functions return a pointer to caller-specific data
 187 that was initialized with their corresponding \fB*_set()\fR function. If no
 188 caller-specific data was assigned with a \fB*_set()\fR function, the results
 189 are undefined.
 190 .SH ERRORS
 191 .sp
 192 .LP
 193 No errors are defined.
 194 .SH ATTRIBUTES
 195 .sp
 196 .LP
 197 See \fBattributes\fR(5) for descriptions of the following attributes:
 198 .sp
 199
 200 .sp
 201 .TS
 202 box;
 203 c | c
 204 l | l .
 205 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 206 _
 207 Interface Stability     Committed
 208 _
 209 MT-Level        Safe
 210 .TE
 211
 212 .SH SEE ALSO
 213 .sp
 214 .LP
 215 \fBdi_init\fR(3DEVINFO), \fBlibdevinfo\fR(3LIB), \fBattributes\fR(5)