xref: /freebsd/contrib/elftoolchain/libelf/elf_getarhdr.3 (revision ae500c1ff8974130f7f2692772cf288b90349e0d)
12de3b87aSKai Wang.\" Copyright (c) 2006,2008 Joseph Koshy.  All rights reserved.
22de3b87aSKai Wang.\"
32de3b87aSKai Wang.\" Redistribution and use in source and binary forms, with or without
42de3b87aSKai Wang.\" modification, are permitted provided that the following conditions
52de3b87aSKai Wang.\" are met:
62de3b87aSKai Wang.\" 1. Redistributions of source code must retain the above copyright
72de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer.
82de3b87aSKai Wang.\" 2. Redistributions in binary form must reproduce the above copyright
92de3b87aSKai Wang.\"    notice, this list of conditions and the following disclaimer in the
102de3b87aSKai Wang.\"    documentation and/or other materials provided with the distribution.
112de3b87aSKai Wang.\"
122de3b87aSKai Wang.\" This software is provided by Joseph Koshy ``as is'' and
132de3b87aSKai Wang.\" any express or implied warranties, including, but not limited to, the
142de3b87aSKai Wang.\" implied warranties of merchantability and fitness for a particular purpose
152de3b87aSKai Wang.\" are disclaimed.  in no event shall Joseph Koshy be liable
162de3b87aSKai Wang.\" for any direct, indirect, incidental, special, exemplary, or consequential
172de3b87aSKai Wang.\" damages (including, but not limited to, procurement of substitute goods
182de3b87aSKai Wang.\" or services; loss of use, data, or profits; or business interruption)
192de3b87aSKai Wang.\" however caused and on any theory of liability, whether in contract, strict
202de3b87aSKai Wang.\" liability, or tort (including negligence or otherwise) arising in any way
212de3b87aSKai Wang.\" out of the use of this software, even if advised of the possibility of
222de3b87aSKai Wang.\" such damage.
232de3b87aSKai Wang.\"
24*ae500c1fSEd Maste.\" $Id: elf_getarhdr.3 3639 2018-10-14 14:07:02Z jkoshy $
252de3b87aSKai Wang.\"
262de3b87aSKai Wang.Dd August 15, 2006
272de3b87aSKai Wang.Dt ELF_GETARHDR 3
28*ae500c1fSEd Maste.Os
292de3b87aSKai Wang.Sh NAME
302de3b87aSKai Wang.Nm elf_getarhdr
312de3b87aSKai Wang.Nd retrieve ar(1) header for an archive member
322de3b87aSKai Wang.Sh LIBRARY
332de3b87aSKai Wang.Lb libelf
342de3b87aSKai Wang.Sh SYNOPSIS
352de3b87aSKai Wang.In libelf.h
362de3b87aSKai Wang.Ft "Elf_Arhdr *"
372de3b87aSKai Wang.Fn elf_getarhdr "Elf *elf"
382de3b87aSKai Wang.Sh DESCRIPTION
392de3b87aSKai WangThe
402de3b87aSKai Wang.Fn elf_getarhdr
412de3b87aSKai Wangfunction returns a pointer to an archive member header for
422de3b87aSKai Wanga descriptor
432de3b87aSKai Wang.Ar elf .
442de3b87aSKai WangThis descriptor must have been returned by a prior call to
452de3b87aSKai Wang.Xr elf_begin 3 ,
462de3b87aSKai Wangand must be a descriptor for a member inside an
472de3b87aSKai Wang.Xr ar 1
482de3b87aSKai Wangarchive.
492de3b87aSKai Wang.Pp
502de3b87aSKai WangStructure
512de3b87aSKai Wang.Vt Elf_Arhdr
522de3b87aSKai Wangincludes the following members:
532de3b87aSKai Wang.Bl -tag -width indent
542de3b87aSKai Wang.It Vt "char *" Va ar_name
552de3b87aSKai WangA pointer to a null terminated string containing the translated
562de3b87aSKai Wangname of the archive member.
572de3b87aSKai Wang.It Vt "char *" Va ar_rawname
582de3b87aSKai WangA pointer to a null terminated string containing the untranslated
592de3b87aSKai Wangname for the archive member, including all
602de3b87aSKai Wang.Xr ar 1
612de3b87aSKai Wangformatting characters and trailing white space.
622de3b87aSKai Wang.It Vt time_t Va ar_date
632de3b87aSKai WangThe timestamp associated with the member.
642de3b87aSKai Wang.It Vt uid_t Va ar_uid
652de3b87aSKai WangThe uid of the creator of the member.
662de3b87aSKai Wang.It Vt gid_t Va ar_gid
672de3b87aSKai WangThe gid of the creator of the member.
682de3b87aSKai Wang.It Vt mode_t Va ar_mode
692de3b87aSKai WangThe file mode of the member.
702de3b87aSKai Wang.It Vt size_t Va ar_size
712de3b87aSKai WangThe size of the member in bytes.
722de3b87aSKai Wang.El
732de3b87aSKai Wang.Sh RETURN VALUES
742de3b87aSKai WangThis function returns a valid pointer to an
752de3b87aSKai Wang.Vt Elf_Arhdr
762de3b87aSKai Wangstructure if successful, or NULL if an error is encountered.
772de3b87aSKai Wang.Sh ERRORS
782de3b87aSKai WangFunction
792de3b87aSKai Wang.Fn elf_getarhdr
802de3b87aSKai Wangmay fail with the following errors:
812de3b87aSKai Wang.Bl -tag -width "[ELF_E_RESOURCE]"
822de3b87aSKai Wang.It Bq Er ELF_E_ARGUMENT
832de3b87aSKai WangArgument
842de3b87aSKai Wang.Ar elf
852de3b87aSKai Wangwas NULL.
862de3b87aSKai Wang.It Bq Er ELF_E_ARGUMENT
872de3b87aSKai WangArgument
882de3b87aSKai Wang.Ar elf
892de3b87aSKai Wangwas not a descriptor for a member of an
902de3b87aSKai Wang.Xr ar 1
912de3b87aSKai Wangarchive.
922de3b87aSKai Wang.El
932de3b87aSKai Wang.Sh SEE ALSO
942de3b87aSKai Wang.Xr elf 3 ,
952de3b87aSKai Wang.Xr elf_begin 3 ,
962de3b87aSKai Wang.Xr elf_getarsym 3 ,
972de3b87aSKai Wang.Xr elf_memory 3
98