SYNOPSIS

    #include "libut/ut.h"
    int UT_var_bindc(char *name, void *cvar);

DESCRIPTION

This function provides a convenient way for a C program to have access to a configuration variable without having to call UT_var_get(3) to read it every time. Instead, this function enacts a ``binding'' from a configuration variable created using UT_var_create(3) to a variable in the C program. When the configuration variable changes value, the updated value is stored in the given C variable.

The C variable whose address is passed as cvar must be of the proper type, i.e., matching the defined type of the configuration variable. In other words,

cvar must point to a double value if name refers to a configuration variable of type UT_var_double.
cvar must point to an int value if name refers to a configuration variable of type UT_var_int.
cvar must point to a char* value if name refers to a configuration variable of type UT_var_string.

The C variable should be considered a read-only value. The only valid way for a C program to set a configuration variable is to use UT_var_set(3).

RETURN VALUE

The return value is always 0. If name refers to a configuration variable that doesn't exist, it logged as a Fatal error, and the application exits with exit status -1.

RELATED CONTROL PORT COMMANDS

The var control port command lists and sets the configuration variables.

SEE ALSO

UT_var_create(3), UT_var_set(3), UT_var_get(3), UT_var_reg_cb(3), UT_var_restrict(3)

AUTHOR

Troy D. Hanson <thanson@users.sourceforge.net>