gbuffer_leftbytes()

gbuffer_leftbytes() returns the number of unread bytes remaining in the given gbuffer_t instance.

C

Prototype

size_t gbuffer_leftbytes(gbuffer_t *gbuf);

Parameters

Key	Type	Description
gbuf	gbuffer_t *	Pointer to the gbuffer_t instance whose unread byte count is to be retrieved.

---

Return Value

Returns the number of unread bytes remaining in the buffer.

Notes

If gbuf is NULL, an error is logged, and 0 is returned.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python

Examples

C

// TODO C examples

JS

// TODO JS examples

Python

# TODO Python examples