Function rcl_lexer_lookahead2_get_text

Function Documentation

const char *rcl_lexer_lookahead2_get_text(const rcl_lexer_lookahead2_t *buffer)

Get the text at the point where it is currently being analyzed.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

Yes

Uses Atomics

No

Lock-Free

Yes

Parameters:

buffer[in] the lookahead2 buffer being used to analyze a string.

Returns:

a pointer inside the original text at the position being analyzed, or

Returns:

NULL if buffer is itself NULL or zero initialized, or

Returns:

an undefined value if buffer is not initialized or has been finalized.