xref: /illumos-gate/usr/src/man/man3devinfo/di_path_prop_lookup_bytes.3devinfo (revision 7ab4e62e3b5c454f248a38bec0d489e8f5543324)
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_LOOKUP_BYTES 3DEVINFO "May 15, 2008"
NAME
di_path_prop_lookup_bytes, di_path_prop_lookup_int64s, di_path_prop_lookup_ints, di_path_prop_lookup_strings - search for a path property
SYNOPSIS

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

int di_path_prop_lookup_bytes(di_path_t path,
 const char *prop_name);

int di_path_prop_lookup_int64s(di_path_t path,
 const char *prop_name);

int di_path_prop_lookup_ints(di_path_t path,
 const char *prop_name, char **prop_data);

int di_path_prop_lookup_strings(di_path_t path,
 const char *prop_name, char **prop_data);
PARAMETERS
path

The handle to a path node in a di_init(3DEVINFO).

prop_name

The name of property for which to search.

prop_data

For di_path_prop_lookup_bytes(), the address to a pointer to an array of unsigned characters containing the property data. For di_path_prop_lookup_int64(), the address to a pointer to an array of 64-bit integers containing the property data. For di_path_prop_lookup_ints(), the address to a pointer to an array of integers containing the property data. For di_path_prop_lookup_strings(), the address to a pointer to a buffer containing a concatenation of null-terminated strings containing the property data.

DESCRIPTION

These functions return the value of a known property name and type.

All memory allocated by these functions is managed by the library and must not be freed by the caller.

RETURN VALUES

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.

ERRORS

These functions will fail if: EINVAL

One of the arguments is invalid.

ENOTSUP

The snapshot contains no property information.

ENXIO

The path property does not exist.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level Safe
SEE ALSO

di_init(3DEVINFO), libdevinfo(3LIB), attributes(5)

Writing Device Drivers