CCS/context_8h_source.html

#ifndef _CCS_CONTEXT_H

#define _CCS_CONTEXT_H


#ifdef __cplusplus

extern "C" {

#endif


extern ccs_result_t

ccs_context_get_name(ccs_context_t context, const char **name_ret);


extern ccs_result_t

ccs_context_get_parameter(

    ccs_context_t    context,

    size_t           index,

    ccs_parameter_t *parameter_ret);


extern ccs_result_t

ccs_context_get_parameters(

    ccs_context_t    context,

    size_t           num_parameters,

    ccs_parameter_t *parameters,

    size_t          *num_parameters_ret);


extern ccs_result_t

ccs_context_get_parameter_by_name(

    ccs_context_t    context,

    const char      *name,

    ccs_parameter_t *parameter_ret);


extern ccs_result_t

ccs_context_get_parameter_index_by_name(

    ccs_context_t context,

    const char   *name,

    ccs_bool_t   *found_ret,

    size_t       *index_ret);


extern ccs_result_t

ccs_context_get_parameter_index(

    ccs_context_t   context,

    ccs_parameter_t parameter,

    ccs_bool_t     *found_ret,

    size_t         *index_ret);


extern ccs_result_t

ccs_context_get_parameter_indexes(

    ccs_context_t    context,

    size_t           num_parameters,

    ccs_parameter_t *parameters,

    ccs_bool_t      *found,

    size_t          *indexes);


extern ccs_result_t

ccs_context_validate_value(

    ccs_context_t context,

    size_t        index,

    ccs_datum_t   value,

    ccs_datum_t  *value_ret);


#ifdef __cplusplus

}

#endif


#endif //_CCS_CONTEXT_H

ccs_bool_t
int32_t ccs_bool_t
A CCS boolean type.
Definition base.h:37

ccs_parameter_t
struct _ccs_parameter_s * ccs_parameter_t
An opaque type defining a CCS parameter.
Definition base.h:95

ccs_context_t
struct _ccs_context_s * ccs_context_t
An opaque type defining a CCS context.
Definition base.h:103

ccs_result_t
enum ccs_result_e ccs_result_t
A commodity type to represent CCS errors and returned by most functions.
Definition base.h:247

ccs_context_get_parameter_indexes
ccs_result_t ccs_context_get_parameter_indexes(ccs_context_t context, size_t num_parameters, ccs_parameter_t *parameters, ccs_bool_t *found, size_t *indexes)
Get the indices of a set of parameters in a context.

ccs_context_get_parameter
ccs_result_t ccs_context_get_parameter(ccs_context_t context, size_t index, ccs_parameter_t *parameter_ret)
Get an parameter in a context given its index.

ccs_context_get_parameter_by_name
ccs_result_t ccs_context_get_parameter_by_name(ccs_context_t context, const char *name, ccs_parameter_t *parameter_ret)
Get an parameter in a context given its name.

ccs_context_get_parameter_index
ccs_result_t ccs_context_get_parameter_index(ccs_context_t context, ccs_parameter_t parameter, ccs_bool_t *found_ret, size_t *index_ret)
Get the index of an parameter in the context.

ccs_context_get_parameter_index_by_name
ccs_result_t ccs_context_get_parameter_index_by_name(ccs_context_t context, const char *name, ccs_bool_t *found_ret, size_t *index_ret)
Get the index of an parameter in the context given its name.

ccs_context_get_parameters
ccs_result_t ccs_context_get_parameters(ccs_context_t context, size_t num_parameters, ccs_parameter_t *parameters, size_t *num_parameters_ret)
Get the parameters in the given context.

ccs_context_validate_value
ccs_result_t ccs_context_validate_value(ccs_context_t context, size_t index, ccs_datum_t value, ccs_datum_t *value_ret)
Validate that a given value at the given index is valid in the context, and return a sanitized value.

ccs_context_get_name
ccs_result_t ccs_context_get_name(ccs_context_t context, const char **name_ret)
Get the name of a context.

ccs_datum_s
A Structure containing a CCS datum.
Definition base.h:494