xref: /freebsd/contrib/elftoolchain/libelf/elf_end.3 (revision ae500c1ff8974130f7f2692772cf288b90349e0d)
12de3b87aSKai Wang.\" Copyright (c) 2006,2008 Joseph Koshy.  All rights reserved.
22de3b87aSKai Wang.\"
32de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without
42de3b87aSKai Wang.\" modification, are permitted provided that the following conditions
52de3b87aSKai Wang.\" are met:
62de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright
72de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer.
82de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright
92de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer in the
102de3b87aSKai Wang.\"    documentation and/or other materials provided with the distribution.
112de3b87aSKai Wang.\"
122de3b87aSKai Wang.\" This software is provided by Joseph Koshy ``as is'' and
132de3b87aSKai Wang.\" any express or implied warranties, including, but not limited to, the
142de3b87aSKai Wang.\" implied warranties of merchantability and fitness for a particular purpose
152de3b87aSKai Wang.\" are disclaimed.  in no event shall Joseph Koshy be liable
162de3b87aSKai Wang.\" for any direct, indirect, incidental, special, exemplary, or consequential
172de3b87aSKai Wang.\" damages (including, but not limited to, procurement of substitute goods
182de3b87aSKai Wang.\" or services; loss of use, data, or profits; or business interruption)
192de3b87aSKai Wang.\" however caused and on any theory of liability, whether in contract, strict
202de3b87aSKai Wang.\" liability, or tort (including negligence or otherwise) arising in any way
212de3b87aSKai Wang.\" out of the use of this software, even if advised of the possibility of
222de3b87aSKai Wang.\" such damage.
232de3b87aSKai Wang.\"
24*ae500c1fSEd Maste.\" $Id: elf_end.3 3639 2018-10-14 14:07:02Z jkoshy $
252de3b87aSKai Wang.\"
262de3b87aSKai Wang.Dd June 29, 2006
272de3b87aSKai Wang.Dt ELF_END 3
28*ae500c1fSEd Maste.Os
292de3b87aSKai Wang.Sh NAME
302de3b87aSKai Wang.Nm elf_end
312de3b87aSKai Wang.Nd release an ELF descriptor
322de3b87aSKai Wang.Sh LIBRARY
332de3b87aSKai Wang.Lb libelf
342de3b87aSKai Wang.Sh SYNOPSIS
352de3b87aSKai Wang.In libelf.h
362de3b87aSKai Wang.Ft int
372de3b87aSKai Wang.Fn elf_end "Elf *elf"
382de3b87aSKai Wang.Sh DESCRIPTION
392de3b87aSKai WangFunction
402de3b87aSKai Wang.Fn elf_end
412de3b87aSKai Wangis used to release the resources associated with an ELF descriptor
422de3b87aSKai Wangpointed to by argument
432de3b87aSKai Wang.Ar elf .
442de3b87aSKai WangThis descriptor must have been allocated by a previous call to
452de3b87aSKai Wang.Xr elf_begin 3
462de3b87aSKai Wangor
472de3b87aSKai Wang.Xr elf_memory 3 .
482de3b87aSKai WangFor programming convenience, a NULL value is permitted for argument
492de3b87aSKai Wang.Ar elf .
502de3b87aSKai Wang.Pp
512de3b87aSKai WangA call to
522de3b87aSKai Wang.Fn elf_end
532de3b87aSKai Wangdecrements the activation count for descriptor
542de3b87aSKai Wang.Ar elf
552de3b87aSKai Wangby one.
562de3b87aSKai WangThe resources associated with the descriptor are only released
572de3b87aSKai Wangwith its activation count goes to zero.
582de3b87aSKai Wang.Pp
592de3b87aSKai WangOnce function
602de3b87aSKai Wang.Fn elf_end
612de3b87aSKai Wangreturns zero, the ELF descriptor
622de3b87aSKai Wang.Ar elf
632de3b87aSKai Wangwill no longer be valid and should not be used further.
642de3b87aSKai Wang.Sh RETURN VALUES
652de3b87aSKai WangFunction
662de3b87aSKai Wang.Fn elf_end
672de3b87aSKai Wangreturns the current value of the ELF descriptor
682de3b87aSKai Wang.Ar elf Ap s
692de3b87aSKai Wangactivation count, or zero if argument
702de3b87aSKai Wang.Ar elf
712de3b87aSKai Wangwas NULL.
722de3b87aSKai Wang.Sh SEE ALSO
732de3b87aSKai Wang.Xr elf 3 ,
742de3b87aSKai Wang.Xr elf_begin 3 ,
752de3b87aSKai Wang.Xr elf_memory 3 ,
762de3b87aSKai Wang.Xr gelf 3
77