usr/src/man/man3lgrp/lgrp_fini.3lgrp

   1 '\" te
   2 .\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH LGRP_FINI 3LGRP "Apr 16, 2003"
   7 .SH NAME
   8 lgrp_fini \- finished using lgroup interface
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-llgrp\fR [ \fIlibrary\fR\&.\|.\|. ]
  13 #include <sys/lgrp_user.h>
  14
  15 \fBint\fR \fBlgrp_fini\fR(\fBlgrp_cookie_t\fR \fIcookie\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBlgrp_fini()\fR function takes a \fIcookie\fR, frees the snapshot of the
  22 lgroup hierarchy created by \fBlgrp_init\fR(3LGRP), and cleans up anything else
  23 set up by \fBlgrp_init()\fR.  After this function is called, any memory
  24 allocated and returned by the lgroup interface might no longer be valid and
  25 should not be used.
  26 .SH RETURN VALUES
  27 .sp
  28 .LP
  29 Upon successful completion, 0 is returned. Otherwise, \(mi1 is returned and
  30 \fBerrno\fR is set to indicate the error.
  31 .SH ERRORS
  32 .sp
  33 .LP
  34 The \fBlgrp_fini()\fR function will fail if:
  35 .sp
  36 .ne 2
  37 .na
  38 \fB\fBEINVAL\fR\fR
  39 .ad
  40 .RS 10n
  41 The \fIcookie\fR is not valid.
  42 .RE
  43
  44 .SH ATTRIBUTES
  45 .sp
  46 .LP
  47 See \fBattributes\fR(5) for descriptions of the following attributes:
  48 .sp
  49
  50 .sp
  51 .TS
  52 box;
  53 c | c
  54 l | l .
  55 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  56 _
  57 Interface Stability     Evolving
  58 _
  59 MT-Level        MT-Safe
  60 .TE
  61
  62 .SH SEE ALSO
  63 .sp
  64 .LP
  65 \fBlgrp_init\fR(3LGRP), \fBlgrp_cookie_stale\fR(3LGRP), \fBliblgrp\fR(3LIB),
  66 \fBattributes\fR(5)