#include "barcodeapi.h"

Data Fields
HqBool(*	barcode_open )(void *p_priv, struct sw_barcode_symbol barcode_symbol)
	Open a barcode generation context. More...

HqBool(*	barcode_render )(void priv, struct sw_barcode_symbol barcode_symbol)
	Generate a barcode bitmap. More...

void(*	barcode_close )(void **p_priv)
	Destroy a barcode generation context. More...

Detailed Description

Barcode API structure.

Allow alternate barcode implementations to be registered via RDR, and then used instead of the HQN provided code.

Field Documentation

void( * sw_barcode_api_20170420::barcode_close) (void **p_priv)

Destroy a barcode generation context.

Parameters

[in,out] p_priv A location that the barcode generation context created by barcode_open() is stored. On exit, *p_priv should be set to NULL.

HqBool( * sw_barcode_api_20170420::barcode_open) (void **p_priv, struct sw_barcode_symbol *barcode_symbol)

Open a barcode generation context.

Parameters

[out]	p_priv	A location to store the barcode generation context.
[in]	barcode_symbol	Input and output parameters of the barcode to generate.

Return values

TRUE	if the barcode generation context was created.
FALSE	if the barcode generation context could not be created. The `barcode_symbol->error.num` field will be set to one of the `SW_BARCODE_ERROR_*` codes, and `barcode_symbol->error.txt` will be set to a zero-terminated string describing the error or `NULL` if there is no information.

If this function succeeds, and *p_priv is not NULL, the RIP will call barcode_close() to destroy the context created.

HqBool( * sw_barcode_api_20170420::barcode_render) (void *priv, struct sw_barcode_symbol *barcode_symbol)

Generate a barcode bitmap.

Parameters

[in,out]	priv	The barcode generation context created by barcode_open().
[in]	barcode_symbol	Input and output parameters of the barcode to generate.

Return values

TRUE	if the barcode generation succeeded. The `barcode_symbol->bitmap` field should have been filled in with details of the barcode bitmap generated.
FALSE	if the barcode generation failed. The `sw_barcode_symbol->error.num` field will be set to one of the `SW_BARCODE_ERROR_*` codes, and `barcode_symbol->error.txt` will be set to a zero-terminated string describing the error or `NULL` if there is no information.

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