sr_input_format Struct Reference

#include <libsigrok.h>

Collaboration diagram for sr_input_format:

Data Fields
char *	id
	The unique ID for this input format. More...
char *	description
	A short description of the input format, which can (for example) be displayed to the user by frontends. More...
int(*	format_match )(const char *filename)
	Check if this input module can load and parse the specified file. More...
int(*	init )(struct sr_input *in, const char *filename)
	Initialize the input module. More...
int(*	loadfile )(struct sr_input *in, const char *filename)
	Load a file, parsing the input according to the file's format. More...

Detailed Description

Definition at line 316 of file libsigrok.h.

Field Documentation

char* sr_input_format::description

A short description of the input format, which can (for example) be displayed to the user by frontends.

Must not be NULL.

Definition at line 324 of file libsigrok.h.

int(* sr_input_format::format_match)(const char *filename)

Check if this input module can load and parse the specified file.

Parameters

filename

The name (and path) of the file to check.

Returns

TRUE if this module knows the format, FALSE if it doesn't.

Definition at line 333 of file libsigrok.h.

char* sr_input_format::id

The unique ID for this input format.

Must not be NULL.

Definition at line 318 of file libsigrok.h.

int(* sr_input_format::init)(struct sr_input *in, const char *filename)

Initialize the input module.

Parameters

in	A pointer to a valid 'struct sr_input' that the caller has to allocate and provide to this function. It is also the responsibility of the caller to free it later.
filename	The name (and path) of the file to use.

Returns

SR_OK upon success, a negative error code upon failure.

Definition at line 345 of file libsigrok.h.

int(* sr_input_format::loadfile)(struct sr_input *in, const char *filename)

Load a file, parsing the input according to the file's format.

This function will send datafeed packets to the session bus, so the calling frontend must have registered its session callbacks beforehand.

The packet types sent across the session bus by this function must include at least SR_DF_HEADER, SR_DF_END, and an appropriate data type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet if appropriate.

Parameters

in	A pointer to a valid 'struct sr_input' that the caller has to allocate and provide to this function. It is also the responsibility of the caller to free it later.
filename	The name (and path) of the file to use.

Returns

SR_OK upon success, a negative error code upon failure.

Definition at line 366 of file libsigrok.h.

---

The documentation for this struct was generated from the following file:

• libsigrok.h