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_getarhdr.3 3639 2018-10-14 14:07:02Z jkoshy $ 25.\" 26.Dd August 15, 2006 27.Dt ELF_GETARHDR 3 28.Os 29.Sh NAME 30.Nm elf_getarhdr 31.Nd retrieve ar(1) header for an archive member 32.Sh LIBRARY 33.Lb libelf 34.Sh SYNOPSIS 35.In libelf.h 36.Ft "Elf_Arhdr *" 37.Fn elf_getarhdr "Elf *elf" 38.Sh DESCRIPTION 39The 40.Fn elf_getarhdr 41function returns a pointer to an archive member header for 42a descriptor 43.Ar elf . 44This descriptor must have been returned by a prior call to 45.Xr elf_begin 3 , 46and must be a descriptor for a member inside an 47.Xr ar 1 48archive. 49.Pp 50Structure 51.Vt Elf_Arhdr 52includes the following members: 53.Bl -tag -width indent 54.It Vt "char *" Va ar_name 55A pointer to a null terminated string containing the translated 56name of the archive member. 57.It Vt "char *" Va ar_rawname 58A pointer to a null terminated string containing the untranslated 59name for the archive member, including all 60.Xr ar 1 61formatting characters and trailing white space. 62.It Vt time_t Va ar_date 63The timestamp associated with the member. 64.It Vt uid_t Va ar_uid 65The uid of the creator of the member. 66.It Vt gid_t Va ar_gid 67The gid of the creator of the member. 68.It Vt mode_t Va ar_mode 69The file mode of the member. 70.It Vt size_t Va ar_size 71The size of the member in bytes. 72.El 73.Sh RETURN VALUES 74This function returns a valid pointer to an 75.Vt Elf_Arhdr 76structure if successful, or NULL if an error is encountered. 77.Sh ERRORS 78Function 79.Fn elf_getarhdr 80may fail with the following errors: 81.Bl -tag -width "[ELF_E_RESOURCE]" 82.It Bq Er ELF_E_ARGUMENT 83Argument 84.Ar elf 85was NULL. 86.It Bq Er ELF_E_ARGUMENT 87Argument 88.Ar elf 89was not a descriptor for a member of an 90.Xr ar 1 91archive. 92.El 93.Sh SEE ALSO 94.Xr elf 3 , 95.Xr elf_begin 3 , 96.Xr elf_getarsym 3 , 97.Xr elf_memory 3 98