istream_get_gbuffer()

istream_get_gbuffer()#

Retrieves the current gbuffer_t * associated with the specified istream. This gbuffer_t * contains the data being processed by the istream.

Prototype

PUBLIC gbuffer_t *istream_get_gbuffer(
    istream_h   istream
);

Parameters

Key

Type

Description

istream

istream_h

The handle to the istream whose gbuffer_t * is to be retrieved.


Return Value

Returns a pointer to the current gbuffer_t * of the istream. If the istream is NULL, the function logs an error and returns NULL.

Notes

  • The returned gbuffer_t * is owned by the istream and must not be freed by the caller.

  • This function is useful for directly inspecting or interacting with the data managed by the istream.

Prototype

// Not applicable in JS

Prototype

# Not applicable in Python
Examples
// TODO C examples
// TODO JS examples
# TODO Python examples