xref: /illumos-gate/usr/src/man/man3devinfo/di_devlink_dup.3devinfo (revision d17be682a2c70b4505d43c830bbd2603da11918d)
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_DEVLINK_DUP 3DEVINFO "May 15, 2008"
NAME
di_devlink_dup, di_devlink_free - copy and free a devlink object
SYNOPSIS

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

di_devlink_t di_devlink_dup(di_devlink_t devlink);

int di_devlink_free(di_devlink_t devlink);
PARAMETERS
devlink

An opaque handle to a devlink.

DESCRIPTION

Typically, a di_devlink_t object is only accessible from within the scope of the di_devlink_walk(3DEVINFO) callback function. The di_devlink_dup() function allows the callback function implementation to make a duplicate copy of the di_devlink_t object. The duplicate copy is valid and accessible until di_devlink_free() is called.

The di_devlink_dup() function returns a copy of a devlink object. The di_devlink_free() function frees this copy.

RETURN VALUES

Upon successful completion, di_devlink_dup() returns a copy of the devlink object passed in. Otherwise, NULL is returned and errno is set to indicate the error.

Upon successful completion, di_devlink_free() returns 0. Otherwise, -1 is returned and errno is set to indicate the error.

ERRORS

The di_devlink_dup() and di_devlink_free() functions will fail if: EINVAL

The devlink argument is not a valid handle.

The di_devlink_dup() function can set errno to any error value that can also be set by malloc(3C).

ATTRIBUTES

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

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

malloc (3C), di_devlink_init (3DEVINFO), di_devlink_path (3DEVINFO), di_devlink_walk (3DEVINFO), libdevinfo (3LIB), attributes (7)