focal (3) nlist.3bsd.gz

Provided by: libbsd-dev_0.10.0-1_amd64 bug

NAME
     nlist — retrieve symbol table name list from an executable file


LIBRARY
     Utility functions from BSD systems (libbsd, -lbsd)


SYNOPSIS
     #include <nlist.h>
     (See libbsd(7) for include usage.)

     int
     nlist(const char *filename, struct nlist *nl);


DESCRIPTION
     The nlist() function retrieves name list entries from the symbol table of an executable file (see elf(5)).
     The argument nl is set to reference the beginning of the list.  The list is preened of binary and invalid
     data; if an entry in the name list is valid, the n_type and n_value for the entry are copied into the list
     referenced by nl.  No other data is copied.  The last entry in the list is always NULL.


RETURN VALUES
     The number of invalid entries is returned if successful; otherwise, if the file filename does not exist or
     is not executable, or the nl pointer is NULL, the returned value is -1.


SEE ALSO
     elf(5)


HISTORY
     A nlist() function appeared in Version 6 AT&T UNIX.