xref: /illumos-gate/usr/src/man/man3picltree/ptree_get_root.3picltree (revision 45d3dd981abb9025d8ac994cf4cc8ce8cb1a9480)
te
Copyright (c) 2000, 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]
PTREE_GET_ROOT 3PICLTREE "Mar 28, 2000"
NAME
ptree_get_root - get the root node handle
SYNOPSIS

cc [ flag... ] file... -lpicltree [ library... ]
#include <picltree.h>

int ptree_get_root(picl_nodehdl_t *nodeh);
DESCRIPTION

The ptree_get_root() function copies the handle of the root node of the PICL tree into the location specified by nodeh.

RETURN VALUES

Upon successful completion, 0 is returned. On failure, a non-negative integer is returned to indicate an error.

ERRORS
PICL_INVALIDARG

Invalid argument

PICL_FAILURE

General system failure

ATTRIBUTES

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

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

libpicltree(3PICLTREE), ptree_create_node(3PICLTREE), attributes(5)