Stringification

Detailed Description

Functions
REDUCT_API size_t	reduct_stringify (reduct_t *reduct, reduct_handle_t handle, char *buffer, size_t size)
	Converts a Reduct handle to its string representation.
REDUCT_API char *	reduct_stringify_alloc (reduct_t *reduct, reduct_handle_t handle)
	Converts a Reduct handle to its string representation, allocating a new buffer.

Function Documentation

reduct_stringify()

REDUCT_API size_t reduct_stringify	(	reduct_t *	reduct,
		reduct_handle_t	handle,
		char *	buffer,
		size_t	size
	)

Converts a Reduct handle to its string representation.

Parameters

reduct	Pointer to the Reduct structure.
handle	The handle to stringify.
buffer	The destination buffer.
size	The size of the destination buffer.

Returns

The number of characters that would have been written if the buffer was large enough, excluding the null terminator.

reduct_stringify_alloc()

REDUCT_API char * reduct_stringify_alloc	(	reduct_t *	reduct,
		reduct_handle_t	handle
	)

Converts a Reduct handle to its string representation, allocating a new buffer.

Parameters

reduct	Pointer to the Reduct structure.
handle	The handle to stringify.

Returns

A null-terminated string that must be freed with free().