xref: /titanic_52/usr/src/man/man3lgrp/lgrp_fini.3lgrp (revision 6a1af1a67532df169a657cce07140be64bdea084)
te
Copyright (c) 2003, 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]
lgrp_fini 3LGRP "16 Apr 2003" "SunOS 5.11" "Locality Group Library Functions"
NAME
lgrp_fini - finished using lgroup interface
SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -llgrp [ library.\|.\|. ] 
#include <sys/lgrp_user.h>

int lgrp_fini(lgrp_cookie_t cookie);
DESCRIPTION

The lgrp_fini() function takes a cookie, frees the snapshot of the lgroup hierarchy created by lgrp_init(3LGRP), and cleans up anything else set up by lgrp_init(). After this function is called, any memory allocated and returned by the lgroup interface might no longer be valid and should not be used.

RETURN VALUES

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

ERRORS

The lgrp_fini() function will fail if:

EINVAL

The cookie is not valid.

ATTRIBUTES

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

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

lgrp_init(3LGRP), lgrp_cookie_stale(3LGRP), liblgrp(3LIB), attributes(5)