rifContextGetInfo

Gets context information.

rif_int rifContextGetInfo(	rif_context context,
	rif_context_info context_info,
	size_t size,
	void * data,
	size_t * size_ret);

Parameters

Parameter	Input/Output	Description
context	input	A valid context object.
context_info	input	Context information to be requested.
size	input	Size of memory allocated for requested context info (including terminating zero for strings).
data	output	A memory pointer to write the requested information to.
size_ret	output	The size of the data stored in data.

Notes

Query operations usually include two steps:

1. First, pass data as NULL along with a value for context_info detailing the information you wish to obtain. This will return the storage requirements for your query data.

2. Secondly, query with size_ret set to NULL to fill the data buffer with the query data.

Return

Returns RIF_SUCCESS if the function is executed successfully, or RIF_ERROR code if a problem is encountered.

Errors

Possible error codes:

• RIF_ERROR_INVALID_CONTEXT - context is not a valid context object.

• RIF_ERROR_INVALID_PARAMETER - data and size_ret are both NULL, or the value of context_info is invalid, or size bytes is not enough to store the requested information.