gbuffer_head_pointer()

`gbuffer_head_pointer()`#

Returns a pointer to the first position of data in the given gbuffer_t instance.

C

Prototype

void *gbuffer_head_pointer(
    gbuffer_t *gbuf
);

Parameters

Key	Type	Description
`gbuf`	`gbuffer_t *`	Pointer to the `gbuffer_t` instance whose data head is to be retrieved.

Return Value

Returns a pointer to the first byte of data in the buffer. If gbuf is NULL, an error is logged and NULL is returned.

Notes

This function does not modify the buffer; it only provides access to the beginning of the stored data.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python