nlist(S)

nlist -- get entries from name list

Syntax

cc ... -lc

#include <nlist.h>

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

Description

The nlist function examines the name list in the executable file whose name is pointed to by filename, and selectively extracts a list of values and puts them in the array of nlist structures pointed to by nl. The name list nl consists of an array of structures containing names of variables, types, and values. The list is terminated with a null name; that is, a null string is in the name position of the structure. Each variable name is looked up in the name list of the file. If the name is found, the type and value of the name are inserted in the next two fields. The type field is set to 0 unless the file was compiled with the -g option. If the name is not found, both entries are set to 0. See a.out(FP) for a discussion of the symbol table structure.

This function is useful for examining the system name list kept in the file /unix. In this way programs can obtain system addresses that are up to date.

Diagnostics

All value entries are set to 0 if the file cannot be read or if it does not contain a valid name list.

The nlist function returns -1 upon error; otherwise it returns 0.

Notes

The <nlist.h> header file is automatically included by <a.out.h> for compatibility. However, if the only information needed from <a.out.h> is for use of nlist, then including <a.out.h> is discouraged. If <a.out.h> is included, the line ``#undef n_name'' may need to follow it.

Standards conformance