NLIST(3)               FreeBSD Library Functions Manual               NLIST(3)

NAME

     nlist - retrieve symbol table name list from an executable file

LIBRARY

     Standard C Library (libc, -lc)

SYNOPSIS

     #include <nlist.h>

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

DESCRIPTION

     The nlist() function is provided for compatibility with legacy
     applications.  Its use is discouraged.  The nlist() function retrieves
     name list entries from elf(5) sections with type SHT_DYNSYM or SHT_SYMTAB
     in an ELF object (for example, an executable file or shared library).
     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, the returned value
     is -1.

SEE ALSO

     elf(5), stab(5)

HISTORY

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

FreeBSD 15.1-STABLE-HBSD         May 19, 2026                         NLIST(3)