usr/src/man/man3devinfo/di_path_prop_next.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_PATH_PROP_NEXT 3DEVINFO "May 15, 2008"
   7 .SH NAME
   8 di_path_prop_next \- libdevinfo path property traversal function
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-ldevinfo\fR [ \fIlibrary\fR... ]
  13 #include <libdevinfo.h>
  14
  15 \fBdi_path_prop_t\fR \fBdi_path_prop_next\fR(\fBdi_path_t\fR \fIpath\fR,
  16      \fBdi_path_prop_t\fR \fIprop\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIpath\fR\fR
  24 .ad
  25 .RS 8n
  26 The handle to a path node in a \fBdi_init\fR(3DEVINFO).
  27 .RE
  28
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIprop\fR\fR
  33 .ad
  34 .RS 8n
  35 The handle to a property.
  36 .RE
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The \fBdi_prop_next()\fR function returns a handle to the next property on the
  42 property list. If prop is \fBDI_PROP_NIL\fR, the handle to the first property
  43 is returned.
  44 .SH RETURN VALUES
  45 .sp
  46 .LP
  47 Upon successful completion, \fBdi_path_prop_next()\fR returns a handle to a
  48 path property object. Otherwise \fBDI_PROP_NIL\fR is returned, and \fBerrno\fR
  49 is set to indicate the error.
  50 .SH ERRORS
  51 .sp
  52 .LP
  53 The \fBdi_prop_next()\fR function will fail if:
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBEINVAL\fR\fR
  58 .ad
  59 .RS 11n
  60 An argument is invalid.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBENOTSUP\fR\fR
  67 .ad
  68 .RS 11n
  69 The snapshot does not contain path property information (\fBDINFOPROP\fR was
  70 not passed to \fBdi_init()\fR).
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBENXIO\fR\fR
  77 .ad
  78 .RS 11n
  79 There are no more properties.
  80 .RE
  81
  82 .SH ATTRIBUTES
  83 .sp
  84 .LP
  85 See \fBattributes\fR(5)  for descriptions of the following attributes:
  86 .sp
  87
  88 .sp
  89 .TS
  90 box;
  91 c | c
  92 l | l .
  93 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  94 _
  95 Interface Stability     Committed
  96 _
  97 MT-Level        Safe
  98 .TE
  99
 100 .SH SEE ALSO
 101 .sp
 102 .LP
 103 \fBlibdevinfo\fR(3LIB), \fBattributes\fR(5)
 104 .sp
 105 .LP
 106 \fIWriting Device Drivers\fR