istream_pop_gbuffer()
#
Pops and returns the current gbuffer_t *
associated with the specified istream. After calling this function, the istream will no longer hold the current gbuffer_t *
, and it becomes the caller’s responsibility to manage it.
Prototype
PUBLIC gbuffer_t *istream_pop_gbuffer(
istream_h istream
);
Parameters
Key |
Type |
Description |
---|---|---|
|
|
The handle to the istream whose current |
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
After calling this function, the istream’s internal
gbuffer_t *
is reset toNULL
.The returned
gbuffer_t *
must be properly decremented (GBUFFER_DECREF
) or freed by the caller to avoid memory leaks.
Prototype
// Not applicable in JS
Prototype
# Not applicable in Python
Examples
// TODO C examples
// TODO JS examples
# TODO Python examples