1*5ac3bc71Schristos.\" $NetBSD: elf_end.3,v 1.6 2024/03/03 17:37:33 christos Exp $ 2e81373b4Schristos.\" 39dd9d0cfSchristos.\" Copyright (c) 2006,2008 Joseph Koshy. All rights reserved. 49dd9d0cfSchristos.\" 59dd9d0cfSchristos.\" Redistribution and use in source and binary forms, with or without 69dd9d0cfSchristos.\" modification, are permitted provided that the following conditions 79dd9d0cfSchristos.\" are met: 89dd9d0cfSchristos.\" 1. Redistributions of source code must retain the above copyright 99dd9d0cfSchristos.\" notice, this list of conditions and the following disclaimer. 109dd9d0cfSchristos.\" 2. Redistributions in binary form must reproduce the above copyright 119dd9d0cfSchristos.\" notice, this list of conditions and the following disclaimer in the 129dd9d0cfSchristos.\" documentation and/or other materials provided with the distribution. 139dd9d0cfSchristos.\" 149dd9d0cfSchristos.\" This software is provided by Joseph Koshy ``as is'' and 159dd9d0cfSchristos.\" any express or implied warranties, including, but not limited to, the 169dd9d0cfSchristos.\" implied warranties of merchantability and fitness for a particular purpose 179dd9d0cfSchristos.\" are disclaimed. in no event shall Joseph Koshy be liable 189dd9d0cfSchristos.\" for any direct, indirect, incidental, special, exemplary, or consequential 199dd9d0cfSchristos.\" damages (including, but not limited to, procurement of substitute goods 209dd9d0cfSchristos.\" or services; loss of use, data, or profits; or business interruption) 219dd9d0cfSchristos.\" however caused and on any theory of liability, whether in contract, strict 229dd9d0cfSchristos.\" liability, or tort (including negligence or otherwise) arising in any way 239dd9d0cfSchristos.\" out of the use of this software, even if advised of the possibility of 249dd9d0cfSchristos.\" such damage. 259dd9d0cfSchristos.\" 263f622274Sjkoshy.\" Id: elf_end.3 3954 2022-03-12 12:07:16Z jkoshy 279dd9d0cfSchristos.\" 289dd9d0cfSchristos.Dd June 29, 2006 299dd9d0cfSchristos.Dt ELF_END 3 30c5261b83Sjkoshy.Os 319dd9d0cfSchristos.Sh NAME 329dd9d0cfSchristos.Nm elf_end 339dd9d0cfSchristos.Nd release an ELF descriptor 349dd9d0cfSchristos.Sh LIBRARY 359dd9d0cfSchristos.Lb libelf 369dd9d0cfSchristos.Sh SYNOPSIS 379dd9d0cfSchristos.In libelf.h 389dd9d0cfSchristos.Ft int 399dd9d0cfSchristos.Fn elf_end "Elf *elf" 409dd9d0cfSchristos.Sh DESCRIPTION 419dd9d0cfSchristosFunction 429dd9d0cfSchristos.Fn elf_end 439dd9d0cfSchristosis used to release the resources associated with an ELF descriptor 449dd9d0cfSchristospointed to by argument 453f622274Sjkoshy.Fa elf . 469dd9d0cfSchristosThis descriptor must have been allocated by a previous call to 479dd9d0cfSchristos.Xr elf_begin 3 489dd9d0cfSchristosor 499dd9d0cfSchristos.Xr elf_memory 3 . 50c5261b83SjkoshyFor programming convenience, a 51c5261b83Sjkoshy.Dv NULL 52c5261b83Sjkoshyvalue is permitted for argument 533f622274Sjkoshy.Fa elf . 549dd9d0cfSchristos.Pp 559dd9d0cfSchristosA call to 569dd9d0cfSchristos.Fn elf_end 579dd9d0cfSchristosdecrements the activation count for descriptor 583f622274Sjkoshy.Fa elf 599dd9d0cfSchristosby one. 609dd9d0cfSchristosThe resources associated with the descriptor are only released 619dd9d0cfSchristoswith its activation count goes to zero. 629dd9d0cfSchristos.Pp 639dd9d0cfSchristosOnce function 649dd9d0cfSchristos.Fn elf_end 659dd9d0cfSchristosreturns zero, the ELF descriptor 663f622274Sjkoshy.Fa elf 679dd9d0cfSchristoswill no longer be valid and should not be used further. 689dd9d0cfSchristos.Sh RETURN VALUES 699dd9d0cfSchristosFunction 709dd9d0cfSchristos.Fn elf_end 719dd9d0cfSchristosreturns the current value of the ELF descriptor 723f622274Sjkoshy.Fa elf Ap s 739dd9d0cfSchristosactivation count, or zero if argument 743f622274Sjkoshy.Fa elf 75c5261b83Sjkoshywas 76c5261b83Sjkoshy.Dv NULL . 779dd9d0cfSchristos.Sh SEE ALSO 789dd9d0cfSchristos.Xr elf 3 , 799dd9d0cfSchristos.Xr elf_begin 3 , 809dd9d0cfSchristos.Xr elf_memory 3 , 819dd9d0cfSchristos.Xr gelf 3 82