ptree_get_propinfo.3picltree revision c10c16dec587a0662068f6e2991c29ed3a9db943
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_propinfo 3PICLTREE "28 Mar 2000" "SunOS 5.11" "PICL Plug-In Library Functions"
NAME
ptree_get_propinfo - get property information
SYNOPSIS

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

int ptree_get_propinfo(picl_prophdl_t proph,
 ptree_propinfo_t *pi);
DESCRIPTION

The ptree_get_propinfo() function gets the information about the property specified by handle proph and copies it into the location specified by pi. See libpicltree(3PICLTREE) for more information about ptree_propinfo_t structure.

RETURN VALUES

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

PICL_STALEHANDLE is returned if the handle is no longer valid. This occurs if the PICL tree was refreshed or reinitialized.

PICL_INVALIDHANDLE is returned if the specified handle never existed.

ERRORS

PICL_INVALIDHANDLE

Invalid handle

PICL_STALEHANDLE

Stale handle

PICL_NOTPROP

Not a property

PICL_FAILURE

General system failure

ATTRIBUTES

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

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityEvolving
MT-LevelMT-Safe
SEE ALSO

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