CAB_lookupPub.h File Reference

Public include file for the CMX symbol table system. More...

#include <CAB/CAB_asBuiltPub.h>

Classes
struct	_CMX_LookupSymbol
	CMX symbol table entry. More...
Typedefs
typedef struct _CMX_LookupTable	CMX_LookupTable
	Typedef for struct _CMX_LookupTable.
typedef struct _CMX_LookupSymbol	CMX_LookupSymbol
	Typedef for struct _CMX_LookupSymbol.
typedef unsigned int	CMX_cb_LookupScan (void *prm, const CMX_LookupSymbol *sym, CMX_asBuiltIdentity *cab)
	Signature for an CMX symbol table database scanning callback routine.
Functions
void	CMX_lookupInsert (CMX_LookupTable *tbl)
	Insert a CMX lookup table into the CMX lookup table list.
void	CMX_lookupRemove (CMX_LookupTable *tbl)
	Remove a CMX lookup table from the CMX lookup table list.
unsigned int	CMX_lookupScan (CMX_cb_LookupScan *rtn, void *prm)
	Scan the CMX symbol list.
const void *	CMX_lookupSymbol (const char *fnd)
	Translate a CMX lookup symbol to an address.

---

Detailed Description

Public include file for the CMX symbol table system.

CVS $Id: CAB_lookupPub.h,v 1.3 2011/08/01 20:59:25 apw Exp $

---

Function Documentation

void CMX_lookupInsert

(

CMX_LookupTable *

tbl

)

Insert a CMX lookup table into the CMX lookup table list.

Parameters:

tbl

(in) Pointer to lookup table

CMX_lookupInsert() inserts a CMX lookup table into the doubly linked list of tables.

References _CMX_LookupTable::chk, _CMX_LookupTable::nxt, and _CMX_LookupTable::prv.

void CMX_lookupRemove

(

CMX_LookupTable *

tbl

)

Remove a CMX lookup table from the CMX lookup table list.

Parameters:

tbl

(in) Pointer to lookup table

CMX_lookupRemove() removes a CMX lookup table from the doubly linked list of tables.

References _CMX_LookupTable::chk, _CMX_LookupTable::nxt, and _CMX_LookupTable::prv.

unsigned int CMX_lookupScan	(	CMX_cb_LookupScan *	rtn,
		void *	prm
	)

Scan the CMX symbol list.

Parameters:

	rtn	(in) Routine called for each symbol
	prm	(in) User parameter passed through to callback

CMX_lookupScan() scans through all symbols managed by CMX lookup and calls the user provided callback routine for each symbol. If the callback returns a failure code (LSB of status code set), the scan is terminated.

Return values:

x

The most recent status code returned by the callback routine

References _CMX_LookupTable::cab, _CMX_LookupTable::nxt, and _CMX_LookupTable::sym.

const void* CMX_lookupSymbol

(

const char *

fnd

)

Translate a CMX lookup symbol to an address.

Parameters:

fnd

(in) Symbol name to find and translate

CMX_lookupSymbol() translates a CMX lookup managed symbol to an address.

Return values:

	NULL	No such symbol
	x	Symbol address

References _CMX_LookupSymbol::add, _CMX_LookupSymbol::nam, _CMX_LookupTable::nxt, and _CMX_LookupTable::sym.