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