gbuffer_getmark()

Retrieves the mark value associated with the given gbuffer_t instance.

C

Prototype

PUBLIC size_t gbuffer_getmark(gbuffer_t *gbuf);

Parameters

Key	Type	Description
gbuf	gbuffer_t *	Pointer to the gbuffer_t instance from which to retrieve the mark value.

---

Return Value

Returns the mark value stored in the gbuffer_t instance. If gbuf is NULL, returns 0.

Notes

The mark value is a user-defined field that can be used to store arbitrary metadata associated with the buffer.

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