1.\" $NetBSD: elf_next.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_next.3 189 2008-07-20 10:38:08Z jkoshy 27.\" 28.Dd June 17, 2006 29.Os 30.Dt ELF_NEXT 3 31.Sh NAME 32.Nm elf_next 33.Nd provide sequential access to the next archive member 34.Sh LIBRARY 35.Lb libelf 36.Sh SYNOPSIS 37.In libelf.h 38.Ft Elf_Cmd 39.Fn elf_next "Elf *elf" 40.Sh DESCRIPTION 41The 42.Fn elf_next 43function causes the ELF archive descriptor corresponding to argument 44.Ar elf 45to be adjusted to provide access to the next member in 46the archive on a subsequent call to 47.Fn elf_begin . 48.Pp 49The return value of 50.Fn elf_next 51is suitable for use in a loop invoking 52.Fn elf_begin . 53.Sh RETURN VALUES 54If successful, function 55.Fn elf_next 56returns the value 57.Dv ELF_C_READ . 58Otherwise, if argument 59.Ar elf 60was not associated with an archive, or if it was 61.Dv NULL , 62or if any other error occurred, the value 63.Dv ELF_C_NULL 64is returned. 65.Sh EXAMPLES 66To process all the members of an archive use: 67.Bd -literal -offset indent 68Elf_Cmd cmd; 69Elf *archive, *e; 70\&... 71cmd = ELF_C_READ; 72archive = elf_begin(fd, cmd, NULL); 73while ((e = elf_begin(fd, cmd, archive)) != (Elf *) 0) 74{ 75 ... process `e' here ... 76 77 cmd = elf_next(e); 78 elf_end(e); 79} 80elf_end(archive); 81.Ed 82.Sh ERRORS 83Function 84.Fn elf_next 85may fail with the following error: 86.Bl -tag -width "[ELF_E_RESOURCE]" 87.It Bq Er ELF_E_ARGUMENT 88Argument 89.Ar elf 90was not associated with a containing 91.Xr ar 1 92archive. 93.El 94.Sh SEE ALSO 95.Xr elf 3 , 96.Xr elf_begin 3 , 97.Xr elf_end 3 , 98.Xr elf_rand 3 99