cl_hp_parse_field(3)

cl_hp_parse_field - Execute field parser .\" .\" .\"============================================================================= .\"

Section 3 libcanlock-dev bookworm source

Description

cl_hp_parse_field

NAME

cl_hp_parse_field - Execute field parser

SYNOPSIS

#include <libcanlock-3/canlock-hp.h>

char *cl_hp_parse_field(const char *data, size_t data_len);

DESCRIPTION

The cl_hp_parse_field() function executes the header field parser.
This implementation executes the canlock-hfp utility in a separate process.

The parameter data should point to the beginning of the input data.
Specify the length of the input data with the data_len parameter.

The input data must be an unfolded "Cancel-Lock" or "Cancel-Key" header field without line break at the end.
The function cl_hp_get_field() can be used to extract a field from the message header.
The function cl_hp_unfold_field() can be used to remove potential folding from an already extracted header field.

RETURN VALUE

If the parser reports success, a pointer to the NUL-terminated output data is returned. Otherwise, NULL is returned.

On success, the caller is responsible to free() the memory block allocated for the output data.

AUTHORS

Michael Baeuerle

REPORTING BUGS

Report bugs to <mailto:michael.baeuerle@gmx.net>.

STANDARDS

cl_hp_parse_field() tries to comply with the following standards:

RFC 8315