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