Device Information Library Functions
dipathpropbytes(3DEVINFO)
NAME
dipathpropbytes, dipathpropints, dipathpropint64s,
dipathpropname, dipathpropstrings, dipathproptype -
access path property information
SYNOPSIS
cc [ flag... ] file... -ldevinfo [ library... ]
#include
char *dipathpropbytes(dipathpropt prop);
int (dipathpropt prop);
int (dipathpropt prop, uchart **propdata);
int (dipathpropt prop, int **propdata);
int (dipathpropt prop, int64t **propdata);
int dipathproptype(dipathpropt prop, char **propdata);
PARAMETERS
prop A handle to a property returned by
dipathpropnext(3DEVINFO).
propdata For dipathpropbytes(), the address of a
pointer to an unsigned character.
For dipathpropints(), the address of a
pointer to an integer.
For dipathpropint64(), the address of a
pointer to a 64-bit integer.
For dipathpropstrings(), the address of
pointer to a character.
DESCRIPTION
These functions access information associated with path pro-
perty values and attributes such as the property name or
data type.
SunOS 5.11 Last change: 15 May 2008 1
Device Information Library Functions
dipathpropbytes(3DEVINFO)
The dipathpropname() function returns a pointer to a
string containing the name of the property.
The dipathproptype() 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 diproptype(3DEVINFO), excluding
DIPROPTYPEUNKNOWN and DIPROPUNDEFINED. Thus,
dipathproptype() can return one of the following con-
stants:
DIPROPTYPEINT Use dipathpropints() to access
property data.
DIPROPTYPEINT64 Use dipathpropint64s() to access
property data.
DIPROPTYPESTRING Use dipathpropstrings() to access
property data.
DIPROPTYPEBYTE Use dipathpropbytes() to access
property data.
The dipathpropbytes() function returns the property data
as a series of unsigned characters.
The dipathpropints() function returns the property data
as a series of integers.
The dipathpropint64s() function returns the property data
as a series of integers.
The dipathpropstrings() function returns the property
data as a concatenation of null-terminated strings.
RETURN VALUES
Upon successful completion, dipathpropbytes(),
dipathpropints(), dipathpropint64s(), and
dipathpropstrings() return a non-negative value, indicat-
ing the number of entries in the property value buffer. If
the property is found, the number of entries in propdata is
returned. Otherwise, -1 is returned and errno is set to
SunOS 5.11 Last change: 15 May 2008 2
Device Information Library Functions
dipathpropbytes(3DEVINFO)
indicate the error.
For dipathpropbytes(), the number of entries is the
number of unsigned characters contained in the buffer
pointed to by propdata.
For dipathpropints(), the number of entries is the number
of integers contained in the buffer pointed to by propdata.
For dipathpropints(), the number of entries is the number
of 64-bit integers contained in the buffer pointed to by
propdata.
For dipathpropstrings(), 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 dipathpropname() function returns the name of the
property.
The dipathproptype() function can return one of types
described in the Description.
ERORS
These functions will fail if:
EINVAL One of the arguments is invalid. For example, the
property type does not match the interface.
ENOTSUP The snapshot contains no property information.
ENXIO The path property does not exist.
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SunOS 5.11 Last change: 15 May 2008 3
Device Information Library Functions
dipathpropbytes(3DEVINFO)
ATRIBUTE TYPE ATRIBUTE VALUE
Interface Stability Committed
MT-Level Safe
SEE ALSO
dipathpropnext(3DEVINFO), diproptype(3DEVINFO),
libdevinfo(3LIB), attributes(5)
Writing Device Drivers
SunOS 5.11 Last change: 15 May 2008 4
Device Information Library Functions
dipathpropbytes(3DEVINFO)
SunOS 5.11 Last change: 15 May 2008 5
|