1*0a6a1f1dSLionel Sambuc.\" $NetBSD: elf_next.3,v 1.2 2014/03/09 16:58:04 christos Exp $ 2*0a6a1f1dSLionel Sambuc.\" 3*0a6a1f1dSLionel Sambuc.\" Copyright (c) 2006,2008 Joseph Koshy. All rights reserved. 4*0a6a1f1dSLionel Sambuc.\" 5*0a6a1f1dSLionel Sambuc.\" Redistribution and use in source and binary forms, with or without 6*0a6a1f1dSLionel Sambuc.\" modification, are permitted provided that the following conditions 7*0a6a1f1dSLionel Sambuc.\" are met: 8*0a6a1f1dSLionel Sambuc.\" 1. Redistributions of source code must retain the above copyright 9*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer. 10*0a6a1f1dSLionel Sambuc.\" 2. Redistributions in binary form must reproduce the above copyright 11*0a6a1f1dSLionel Sambuc.\" notice, this list of conditions and the following disclaimer in the 12*0a6a1f1dSLionel Sambuc.\" documentation and/or other materials provided with the distribution. 13*0a6a1f1dSLionel Sambuc.\" 14*0a6a1f1dSLionel Sambuc.\" This software is provided by Joseph Koshy ``as is'' and 15*0a6a1f1dSLionel Sambuc.\" any express or implied warranties, including, but not limited to, the 16*0a6a1f1dSLionel Sambuc.\" implied warranties of merchantability and fitness for a particular purpose 17*0a6a1f1dSLionel Sambuc.\" are disclaimed. in no event shall Joseph Koshy be liable 18*0a6a1f1dSLionel Sambuc.\" for any direct, indirect, incidental, special, exemplary, or consequential 19*0a6a1f1dSLionel Sambuc.\" damages (including, but not limited to, procurement of substitute goods 20*0a6a1f1dSLionel Sambuc.\" or services; loss of use, data, or profits; or business interruption) 21*0a6a1f1dSLionel Sambuc.\" however caused and on any theory of liability, whether in contract, strict 22*0a6a1f1dSLionel Sambuc.\" liability, or tort (including negligence or otherwise) arising in any way 23*0a6a1f1dSLionel Sambuc.\" out of the use of this software, even if advised of the possibility of 24*0a6a1f1dSLionel Sambuc.\" such damage. 25*0a6a1f1dSLionel Sambuc.\" 26*0a6a1f1dSLionel Sambuc.\" Id: elf_next.3 189 2008-07-20 10:38:08Z jkoshy 27*0a6a1f1dSLionel Sambuc.\" 28*0a6a1f1dSLionel Sambuc.Dd June 17, 2006 29*0a6a1f1dSLionel Sambuc.Os 30*0a6a1f1dSLionel Sambuc.Dt ELF_NEXT 3 31*0a6a1f1dSLionel Sambuc.Sh NAME 32*0a6a1f1dSLionel Sambuc.Nm elf_next 33*0a6a1f1dSLionel Sambuc.Nd provide sequential access to the next archive member 34*0a6a1f1dSLionel Sambuc.Sh LIBRARY 35*0a6a1f1dSLionel Sambuc.Lb libelf 36*0a6a1f1dSLionel Sambuc.Sh SYNOPSIS 37*0a6a1f1dSLionel Sambuc.In libelf.h 38*0a6a1f1dSLionel Sambuc.Ft Elf_Cmd 39*0a6a1f1dSLionel Sambuc.Fn elf_next "Elf *elf" 40*0a6a1f1dSLionel Sambuc.Sh DESCRIPTION 41*0a6a1f1dSLionel SambucThe 42*0a6a1f1dSLionel Sambuc.Fn elf_next 43*0a6a1f1dSLionel Sambucfunction causes the ELF archive descriptor corresponding to argument 44*0a6a1f1dSLionel Sambuc.Ar elf 45*0a6a1f1dSLionel Sambucto be adjusted to provide access to the next member in 46*0a6a1f1dSLionel Sambucthe archive on a subsequent call to 47*0a6a1f1dSLionel Sambuc.Fn elf_begin . 48*0a6a1f1dSLionel Sambuc.Pp 49*0a6a1f1dSLionel SambucThe return value of 50*0a6a1f1dSLionel Sambuc.Fn elf_next 51*0a6a1f1dSLionel Sambucis suitable for use in a loop invoking 52*0a6a1f1dSLionel Sambuc.Fn elf_begin . 53*0a6a1f1dSLionel Sambuc.Sh RETURN VALUES 54*0a6a1f1dSLionel SambucIf successful, function 55*0a6a1f1dSLionel Sambuc.Fn elf_next 56*0a6a1f1dSLionel Sambucreturns the value 57*0a6a1f1dSLionel Sambuc.Dv ELF_C_READ . 58*0a6a1f1dSLionel SambucOtherwise, if argument 59*0a6a1f1dSLionel Sambuc.Ar elf 60*0a6a1f1dSLionel Sambucwas not associated with an archive, or if it was 61*0a6a1f1dSLionel Sambuc.Dv NULL , 62*0a6a1f1dSLionel Sambucor if any other error occurred, the value 63*0a6a1f1dSLionel Sambuc.Dv ELF_C_NULL 64*0a6a1f1dSLionel Sambucis returned. 65*0a6a1f1dSLionel Sambuc.Sh EXAMPLES 66*0a6a1f1dSLionel SambucTo process all the members of an archive use: 67*0a6a1f1dSLionel Sambuc.Bd -literal -offset indent 68*0a6a1f1dSLionel SambucElf_Cmd cmd; 69*0a6a1f1dSLionel SambucElf *archive, *e; 70*0a6a1f1dSLionel Sambuc\&... 71*0a6a1f1dSLionel Sambuccmd = ELF_C_READ; 72*0a6a1f1dSLionel Sambucarchive = elf_begin(fd, cmd, NULL); 73*0a6a1f1dSLionel Sambucwhile ((e = elf_begin(fd, cmd, archive)) != (Elf *) 0) 74*0a6a1f1dSLionel Sambuc{ 75*0a6a1f1dSLionel Sambuc ... process `e' here ... 76*0a6a1f1dSLionel Sambuc 77*0a6a1f1dSLionel Sambuc cmd = elf_next(e); 78*0a6a1f1dSLionel Sambuc elf_end(e); 79*0a6a1f1dSLionel Sambuc} 80*0a6a1f1dSLionel Sambucelf_end(archive); 81*0a6a1f1dSLionel Sambuc.Ed 82*0a6a1f1dSLionel Sambuc.Sh ERRORS 83*0a6a1f1dSLionel SambucFunction 84*0a6a1f1dSLionel Sambuc.Fn elf_next 85*0a6a1f1dSLionel Sambucmay fail with the following error: 86*0a6a1f1dSLionel Sambuc.Bl -tag -width "[ELF_E_RESOURCE]" 87*0a6a1f1dSLionel Sambuc.It Bq Er ELF_E_ARGUMENT 88*0a6a1f1dSLionel SambucArgument 89*0a6a1f1dSLionel Sambuc.Ar elf 90*0a6a1f1dSLionel Sambucwas not associated with a containing 91*0a6a1f1dSLionel Sambuc.Xr ar 1 92*0a6a1f1dSLionel Sambucarchive. 93*0a6a1f1dSLionel Sambuc.El 94*0a6a1f1dSLionel Sambuc.Sh SEE ALSO 95*0a6a1f1dSLionel Sambuc.Xr elf 3 , 96*0a6a1f1dSLionel Sambuc.Xr elf_begin 3 , 97*0a6a1f1dSLionel Sambuc.Xr elf_end 3 , 98*0a6a1f1dSLionel Sambuc.Xr elf_rand 3 99