external/bsd/elftoolchain/dist/libelf/elf_end.3

   1 .\"     $NetBSD: elf_end.3,v 1.2 2014/03/09 16:58:04 christos Exp $
   2 .\"
   3 .\" Copyright (c) 2006,2008 Joseph Koshy.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" This software is provided by Joseph Koshy ``as is'' and
  15 .\" any express or implied warranties, including, but not limited to, the
  16 .\" implied warranties of merchantability and fitness for a particular purpose
  17 .\" are disclaimed.  in no event shall Joseph Koshy be liable
  18 .\" for any direct, indirect, incidental, special, exemplary, or consequential
  19 .\" damages (including, but not limited to, procurement of substitute goods
  20 .\" or services; loss of use, data, or profits; or business interruption)
  21 .\" however caused and on any theory of liability, whether in contract, strict
  22 .\" liability, or tort (including negligence or otherwise) arising in any way
  23 .\" out of the use of this software, even if advised of the possibility of
  24 .\" such damage.
  25 .\"
  26 .\" Id: elf_end.3 189 2008-07-20 10:38:08Z jkoshy
  27 .\"
  28 .Dd June 29, 2006
  29 .Os
  30 .Dt ELF_END 3
  31 .Sh NAME
  32 .Nm elf_end
  33 .Nd release an ELF descriptor
  34 .Sh LIBRARY
  35 .Lb libelf
  36 .Sh SYNOPSIS
  37 .In libelf.h
  38 .Ft int
  39 .Fn elf_end "Elf *elf"
  40 .Sh DESCRIPTION
  41 Function
  42 .Fn elf_end
  43 is used to release the resources associated with an ELF descriptor
  44 pointed to by argument
  45 .Ar elf .
  46 This descriptor must have been allocated by a previous call to
  47 .Xr elf_begin 3
  48 or
  49 .Xr elf_memory 3 .
  50 For programming convenience, a NULL value is permitted for argument
  51 .Ar elf .
  52 .Pp
  53 A call to
  54 .Fn elf_end
  55 decrements the activation count for descriptor
  56 .Ar elf
  57 by one.
  58 The resources associated with the descriptor are only released
  59 with its activation count goes to zero.
  60 .Pp
  61 Once function
  62 .Fn elf_end
  63 returns zero, the ELF descriptor
  64 .Ar elf
  65 will no longer be valid and should not be used further.
  66 .Sh RETURN VALUES
  67 Function
  68 .Fn elf_end
  69 returns the current value of the ELF descriptor
  70 .Ar elf Ap s
  71 activation count, or zero if argument
  72 .Ar elf
  73 was NULL.
  74 .Sh SEE ALSO
  75 .Xr elf 3 ,
  76 .Xr elf_begin 3 ,
  77 .Xr elf_memory 3 ,
  78 .Xr gelf 3