te
Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
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.
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.
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]
di_path_prop_bytes, di_path_prop_ints, di_path_prop_int64s, di_path_prop_name, di_path_prop_strings, di_path_prop_type - access path property information

cc [ flag... ] file... -ldevinfo [ library... ]
#include <libdevinfo.h>

char *di_path_prop_bytes(di_path_prop_t prop);

int (di_path_prop_t prop);

int (di_path_prop_t prop, uchar_t **prop_data);

int (di_path_prop_t prop, int **prop_data);

int (di_path_prop_t prop, int64_t **prop_data);

int di_path_prop_type(di_path_prop_t prop, char **prop_data);

prop

prop_data

These functions access information associated with path property values and attributes such as the property name or data type.

The di_path_prop_name() function returns a pointer to a string containing the name of the property.

The di_path_prop_type() function returns the type of the path property. The type determines the appropriate interface to access property values. Possible property types are the same as for di_prop_type(3DEVINFO), excluding DI_PROP_TYPE_UNKNOWN and DI_PROP_UNDEFINED. Thus, di_path_prop_type() can return one of the following constants:

DI_PROP_TYPE_INT

DI_PROP_TYPE_INT64

DI_PROP_TYPE_STRING

DI_PROP_TYPE_BYTE

The di_path_prop_bytes() function returns the property data as a series of unsigned characters.

The di_path_prop_ints() function returns the property data as a series of integers.

The di_path_prop_int64s() function returns the property data as a series of integers.

The di_path_prop_strings() function returns the property data as a concatenation of null-terminated strings.

Upon successful completion, di_path_prop_bytes(), di_path_prop_ints(), di_path_prop_int64s(), and di_path_prop_strings() return a non-negative value, indicating the number of entries in the property value buffer. If the property is found, the number of entries in prop_data is returned. Otherwise, -1 is returned and errno is set to indicate the error.

For di_path_prop_bytes(), the number of entries is the number of unsigned characters contained in the buffer pointed to by prop_data.

For di_path_prop_ints(), the number of entries is the number of integers contained in the buffer pointed to by prop_data.

For di_path_prop_ints(), the number of entries is the number of 64-bit integers contained in the buffer pointed to by prop_data.

For di_path_prop_strings(), the number of entries is the number of null-terminated strings contained in the buffer. The strings are stored in a concatenated format in the buffer.

The di_path_prop_name() function returns the name of the property.

The di_path_prop_type() function can return one of types described in the Description.

These functions will fail if:

EINVAL

ENOTSUP

ENXIO

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Committed
MT-Level	Safe

di_path_prop_next(3DEVINFO), di_prop_type(3DEVINFO), libdevinfo(3LIB), attributes(5)

Writing Device Drivers