elf_getarsym(3) [netbsd man page]

ELF_GETARSYM(3) 					   BSD Library Functions Manual 					   ELF_GETARSYM(3)

NAME

     elf_getarsym -- retrieve the symbol table of an archive

LIBRARY

     ELF Access Library (libelf, -lelf)

SYNOPSIS

     #include <libelf.h>

     Elf_Arsym *
     elf_getarsym(Elf *elf, size_t *ptr);

DESCRIPTION

     The function elf_getarsym() retrieves the symbol table for an ar(1) archive, if one is available.

     Argument elf should be a descriptor for an ar(1) archive opened using elf_begin() or elf_memory().

     If the archive elf contains a symbol table with n entries, this function returns a pointer to an array of n+1 Elf_Arsym structures.  An
     Elf_Arsym structure has the following elements:
     char * as_name
	     This structure member is a pointer to a null-terminated symbol name.
     off_t as_off
	     This structure member contains the byte offset from the beginning of the archive to the header for the archive member.  This value is
	     suitable for use with elf_rand(3).
     unsigned long as_hash
	     This structure member contains a portable hash value for the symbol name, as computed by elf_hash(3).

     The last entry of the returned array will have a NULL value for member as_name, a zero value for member as_off and an illegal value of ~0UL
     for as_hash.

     If argument ptr is non-null, the elf_getarsym() function will store the number of table entries returned (including the sentinel entry at the
     end) into the location it points to.

RETURN VALUES

     Function elf_getarsym() returns a pointer to an array of Elf_Arsym structures if successful, or a NULL pointer if an error was encountered.

     If argument ptr is non-null and there was no error, the library will store the number of archive symbol entries returned into the location it
     points to.  If argument ptr is non-null and an error was encountered, the library will set the location pointed to by it to zero.

ERRORS

     Function elf_getarsym() may fail with the following errors:

     [ELF_E_ARGUMENT]  Argument elf was NULL.

     [ELF_E_ARGUMENT]  Argument elf was not a descriptor for an ar(1) archive.

SEE ALSO

     elf(3), elf_begin(3), elf_getarhdr(3), elf_hash(3), elf_memory(3), elf_next(3), elf_rand(3)

BSD
								  August 15, 2006							       BSD

elf_getarsym(3ELF)					       ELF Library Functions						elf_getarsym(3ELF)

NAME

       elf_getarsym - retrieve archive symbol table

SYNOPSIS

       cc [ flag ... ] file ... -lelf [ library ... ]
       #include <libelf.h>

       Elf_Arsym *elf_getarsym(Elf *elf, size_t *ptr);

DESCRIPTION

       The  elf_getarsym()  function returns a pointer to the archive symbol table, if one is available for the ELF descriptor elf. Otherwise, the
       archive doesn't have a symbol table, an error occurred, or elf was null; elf_getarsym() then returns a null value. The symbol table  is	an
       array of structures that include the following members.

	      char *as_name;
	      size_t	as_off;
	      unsigned long  as_hash;

       These members have the following semantics:

       as_name	       A pointer to a null-terminated symbol name resides here.

       as_off	       This  value  is	a byte offset from the beginning of the archive to the member's header. The archive member residing at the
		       given offset defines the associated symbol. Values in as_off may be passed as arguments to elf_rand(). See  elf_begin(3ELF)
		       to access the desired archive member.

       as_hash	       This is a hash value for the name, as computed by elf_hash().

       If  ptr	is  non-null,  the library stores the number of table entries in the location to which ptr points. This value is set to 0 when the
       return value is NULL. The table's last entry, which is included in the count, has a null as_name, a zero value for  as_off,  and  ~0UL  for
       as_hash.

       The hash value returned is guaranteed not to be the bit pattern of all ones ( ~0UL).

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Stable			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       ar.h(3HEAD), elf(3ELF), elf_begin(3ELF), elf_getarhdr(3ELF), elf_hash(3ELF), libelf(3LIB), attributes(5)

SunOS 5.10							    11 Jul 2001 						elf_getarsym(3ELF)