FMX_pubdefs.h File Reference

Public definitions for the ITC package. More...

Defines
#define	FMX_L_ENUM_TABLES   (6)
	Number of enumeration tables FMX recognizes.
Typedefs
typedef struct _FMX_Connection	FMX_Connection
	Typedef for struct _FMX_Connection.
typedef enum _FMX_EnumTableList	FMX_EnumTableList
	Typedef for enum _FMX_EnumTableList.
typedef enum _FMX_FileGroup	FMX_FileGroup
	Typedef for enum _FMX_FileGroup.
typedef enum _FMX_CaptureModule	FMX_CaptureModule
	Typedef for enum _FMX_CaptureModule.
typedef unsigned int	FMX_cb_scanFilesByKey (void *prm, unsigned int key, const char *dir, FMX_FileGroup group, unsigned int flight, unsigned int visible, const char *tag, unsigned int index, unsigned int size, const char *date, const char *name, const char *pkg, const char *ver, const char *con, FMX_CaptureModule captured, unsigned int contents, unsigned int count, const unsigned int *dat)
	Signature for a FMX_scanFilesByKey callback function.
typedef unsigned int	FMX_cb_scanFOFmembers (void *prm, unsigned int visible, unsigned int key, const char *dir, unsigned int index, unsigned int size, const char *date, const char *name)
	Signature for a FMX_scanFOFmembers callback function.
typedef unsigned int	FMX_cb_scanSBSmembers (void *prm, unsigned int visible, unsigned int key, const char *dir, unsigned int index, unsigned int size, const char *date, const char *name, const char *pkg, const char *ver, const char *con, FMX_CaptureModule captured, unsigned int contents, unsigned int count, const unsigned int *dat)
	Signature for a FMX_scanSBSmembers callback function.
Enumerations
enum	_FMX_EnumTableList {   FMX_ENUM_TABLE_DEVICE = 0,   FMX_ENUM_TABLE_FILETYPE = 1,   FMX_ENUM_TABLE_HOST = 2,   FMX_ENUM_TABLE_INSTRUMENT = 3,   FMX_ENUM_TABLE_NODE = 4,   FMX_ENUM_TABLE_TAG = 5 }
	Enumeration of enumeration tables FMX recognizes (!). More...
enum	_FMX_FileGroup {   FMX_GRP_UNKNOWN = -1,   FMX_GRP_SIMPLE = 0,   FMX_GRP_COMPOUND = 1,   FMX_GRP_MODULE = 2 }
	Enumeration of the groups filetypes can belong to. More...
enum	_FMX_CaptureModule {   FMX_CAP_MOD_NONE = 0,   FMX_CAP_MOD_CDM = 1,   FMX_CAP_MOD_REL = 2 }
	Enumeration of the methods used to capture extended module information. More...
Functions
unsigned int	FMX_connect (FMX_Connection **con, const char *host, const char *user, const char *pass, int port)
unsigned int	FMX_disconnect (FMX_Connection *ucb)
unsigned int	FMX_findCDMbyKey (FMX_Connection *ucb, unsigned int key, const char *tag, unsigned int absolute, char *nambuf, unsigned int bufmax, unsigned int *namlen)
unsigned int	FMX_initialize (void)
unsigned int	FMX_scanFilesByKey (FMX_Connection *ucb, unsigned int key, FMX_cb_scanFilesByKey rtn, void *prm)
unsigned int	FMX_scanFOFmembers (FMX_Connection *ucb, unsigned int key, unsigned int flight, FMX_cb_scanFOFmembers rtn, void *prm)
unsigned int	FMX_scanSBSmembers (FMX_Connection *ucb, unsigned int key, const char *tag, unsigned int flight, FMX_cb_scanSBSmembers rtn, void *prm)
void	FMX_shutdown (void)

---

Detailed Description

Public definitions for the ITC package.

CVS $Id: FMX_pubdefs.h,v 1.8 2011/03/25 20:42:51 apw Exp $

Author:

A.P.Waite

---

Typedef Documentation

FMX_cb_scanFilesByKey

Signature for a FMX_scanFilesByKey callback function.

< "List key" file processing routine

FMX_cb_scanFOFmembers

Signature for a FMX_scanFOFmembers callback function.

< Scan the members of a FOF file

FMX_cb_scanSBSmembers

Signature for a FMX_scanSBSmembers callback function.

< Scan the members of an SBS file

---

Enumeration Type Documentation

enum _FMX_CaptureModule

Enumeration of the methods used to capture extended module information.

Enumerator:

FMX_CAP_MOD_NONE	No information captured
FMX_CAP_MOD_CDM	Search CDM macro information
FMX_CAP_MOD_REL	Search shareable symbols

enum _FMX_EnumTableList

Enumeration of enumeration tables FMX recognizes (!).

Enumerator:

FMX_ENUM_TABLE_DEVICE	Device table
FMX_ENUM_TABLE_FILETYPE	Filetype table
FMX_ENUM_TABLE_HOST	Host table
FMX_ENUM_TABLE_INSTRUMENT	Instrument table
FMX_ENUM_TABLE_NODE	Node table
FMX_ENUM_TABLE_TAG	Tag table

enum _FMX_FileGroup

Enumeration of the groups filetypes can belong to.

Enumerator:

FMX_GRP_UNKNOWN	Unknown filetype membership
FMX_GRP_SIMPLE	Member of group "simple"
FMX_GRP_COMPOUND	Member of group "compound"
FMX_GRP_MODULE	Member of group "module"