lint_keyoff1.c File Reference

Purpose

The keyoff linter checks whether an input starts with a GS1 Company Prefix ("GCP") from its second character position.

Remarks

The GCP is defined in the GS1 General Specifications section "GS1 Company Prefix".

Functional Description

gs1_lint_keyoff1()

GS1_SYNTAX_DICTIONARY_API gs1_lint_err_t gs1_lint_keyoff1	(	const char *const	data,
		size_t *const	err_pos,
		size_t *const	err_len
	)

Used to ensure that an AI component starts with a GCP from its second position.

Parameters

[in]	data	Pointer to the null-terminated data to be linted. Must not be NULL.
[out]	err_pos	To facilitate error highlighting, the start position of the bad data is written to this pointer, if not NULL.
[out]	err_len	The length of the bad data is written to this pointer, if not NULL.

Returns

GS1_LINTER_OK if okay.

GS1_LINTER_INVALID_GCP_PREFIX if the data does not start with a GCP.

GS1_LINTER_TOO_SHORT_FOR_KEY if the data is too short to start with a GCP.

GS1_LINTER_GCP_DATASOURCE_OFFLINE if the user-provided GCP lookup source is unavailable and this should result in the linting failing. [IMPLEMENTATION SPECIFIC]

{
 
        size_t len;
        gs1_lint_err_t ret;
 
        assert(data);
 
        len = strlen(data);
 
        if (len < 2)
                GS1_LINTER_RETURN_ERROR(
                        GS1_LINTER_TOO_SHORT_FOR_KEY,
                        0,
                        len
                );
 
        ret = gs1_lint_key(data + 1, err_pos, err_len);
 
        assert(ret == GS1_LINTER_OK ||
               ret == GS1_LINTER_TOO_SHORT_FOR_KEY ||
               ret == GS1_LINTER_INVALID_GCP_PREFIX ||
               ret == GS1_LINTER_GCP_DATASOURCE_OFFLINE);
 
        if (ret != GS1_LINTER_OK)
                GS1_LINTER_RETURN_ERROR(
                        ret,
                        *err_pos + 1,
                        *err_len
                );
 
        GS1_LINTER_RETURN_OK;
 
}