libstdf_funcs.h File Reference

---

Detailed Description

Publicly exported functions.

Go to the source code of this file.

Defines
#define	stdf_init_header(header, type)   INIT_HEADER(header, type)
#define	stdf_get_rec_name_from_head(h)   stdf_get_rec_name(h.REC_TYP, h.REC_SUB)
#define	stdf_get_rec_name_from_rec(r)   stdf_get_rec_name(r->header.REC_TYP, r->header.REC_SUB)
Functions
stdf_file *	stdf_open (char *)
stdf_file *	stdf_open_ex (char *, uint32_t,...)
stdf_file *	stdf_dopen (int)
stdf_file *	stdf_dopen_ex (int, uint32_t,...)
int	stdf_close (stdf_file *)
int	stdf_set_setting (stdf_file *, uint32_t,...)
void	stdf_get_setting (stdf_file *, uint32_t,...)
rec_unknown *	stdf_read_record (stdf_file *)
rec_unknown *	stdf_read_record_raw (stdf_file *)
rec_unknown *	stdf_parse_raw_record (rec_unknown *)
void	stdf_free_record (rec_unknown *)
ssize_t	stdf_write_record (stdf_file *, void *)
char *	stdf_get_rec_name (rec_typ, rec_sub)
int	stdf_rec_to_idx (void *)
int	stdf_rec_to_idx_count ()
int	stdf_rec_name_to_idx (char *)
char *	stdf_get_Vn_name (int)
void	stdf_get_Vn_name_r (int, char *)

---

Function Documentation

int stdf_close (  stdf_file *   )

Close an open file Examples: dump_records_to_ascii.c, dump_records_to_html.c, example.c, is_valid_stdf.c, record_stats.c, and stdf2xtdf.c.

stdf_file* stdf_dopen (  int   )

Open a file descriptor with default options

stdf_file* stdf_dopen_ex (  int  , uint32_t  ,   ... )

Open a file descriptor with custom options

void stdf_free_record (  rec_unknown *   )

Free a record Examples: dump_records_to_ascii.c, dump_records_to_html.c, example.c, is_valid_stdf.c, record_stats.c, and stdf2xtdf.c.

char* stdf_get_rec_name (  rec_typ  , rec_sub  )

Translate a record into the 3 letter spec name Examples: dump_records_to_ascii.c, is_valid_stdf.c, record_stats.c, and stdf2xtdf.c.

char* stdf_get_Vn_name (  int   )

Translate a Vn type into the 2 letter spec name Examples: dump_records_to_ascii.c, and stdf2xtdf.c.

void stdf_get_Vn_name_r (  int  , char *  )

Translate a Vn type into the 2 letter spec name (reentrant version)

stdf_file* stdf_open (  char *   )

Open a file with default options Examples: dump_records_to_ascii.c, dump_records_to_html.c, example.c, is_valid_stdf.c, record_stats.c, and stdf2xtdf.c.

stdf_file* stdf_open_ex (  char *  , uint32_t  ,   ... )

Open a file with custom options

rec_unknown* stdf_parse_raw_record (  rec_unknown *   )

Parse a previously read record

rec_unknown* stdf_read_record (  stdf_file *   )

Read in the next record and parse it Examples: dump_records_to_ascii.c, example.c, is_valid_stdf.c, record_stats.c, and stdf2xtdf.c.

rec_unknown* stdf_read_record_raw (  stdf_file *   )

Read in the next record raw Examples: dump_records_to_html.c.

int stdf_rec_name_to_idx (  char *   )

Normalize the record names into array indexes

int stdf_rec_to_idx (  void *   )

Normalize the record namespace into array indexes

int stdf_rec_to_idx_count (   )

Highest array reference the normalize will return

ssize_t stdf_write_record (  stdf_file *  , void *  )

Write out a record

---