KRB5_CONFIG

KRB5_CONFIG_GET

Section: C Library Functions (3) Local index Up

BSD mandoc
HEIMDAL

NAME

krb5_config_file_free krb5_config_free_strings krb5_config_get krb5_config_get_bool krb5_config_get_bool_default krb5_config_get_int krb5_config_get_int_default krb5_config_get_list krb5_config_get_next krb5_config_get_string krb5_config_get_string_default krb5_config_get_strings krb5_config_get_time krb5_config_get_time_default krb5_config_parse_file krb5_config_parse_file_multi krb5_config_vget krb5_config_vget_bool krb5_config_vget_bool_default krb5_config_vget_int krb5_config_vget_int_default krb5_config_vget_list krb5_config_vget_next krb5_config_vget_string krb5_config_vget_string_default krb5_config_vget_strings krb5_config_vget_time krb5_config_vget_time_default - get configuration value

LIBRARY

Kerberos 5 Library (libkrb5, -lkrb5)

SYNOPSIS

In krb5.h Ft krb5_error_code Fo krb5_config_file_free Fa krb5_context context Fa krb5_config_section *s Fc Ft void Fo krb5_config_free_strings Fa char **strings Fc Ft const void * Fo krb5_config_get Fa krb5_context context Fa const krb5_config_section *c Fa int type Fa ... Fc Ft krb5_boolean Fo krb5_config_get_bool Fa krb5_context context Fa krb5_config_section *c Fa ... Fc Ft krb5_boolean Fo krb5_config_get_bool_default Fa krb5_context context Fa krb5_config_section *c Fa krb5_boolean def_value Fa ... Fc Ft int Fo krb5_config_get_int Fa krb5_context context Fa krb5_config_section *c Fa ... Fc Ft int Fo krb5_config_get_int_default Fa krb5_context context Fa krb5_config_section *c Fa int def_value Fa ... Fc Ft const char* Fo krb5_config_get_string Fa krb5_context context Fa krb5_config_section *c Fa ... Fc Ft const char* Fo krb5_config_get_string_default Fa krb5_context context Fa krb5_config_section *c Fa const char *def_value Fa ... Fc Ft char** Fo krb5_config_get_strings Fa krb5_context context Fa const krb5_config_section *c Fa ... Fc Ft int Fo krb5_config_get_time Fa krb5_context context Fa krb5_config_section *c Fa ... Fc Ft int Fo krb5_config_get_time_default Fa krb5_context context Fa krb5_config_section *c Fa int def_value Fa ... Fc Ft krb5_error_code Fo krb5_config_parse_file Fa krb5_context context Fa const char *fname Fa krb5_config_section **res Fc Ft krb5_error_code Fo krb5_config_parse_file_multi Fa krb5_context context Fa const char *fname Fa krb5_config_section **res Fc Ft const void * Fo krb5_config_vget Fa krb5_context context Fa const krb5_config_section *c Fa int type Fa va_list args Fc Ft krb5_boolean Fo krb5_config_vget_bool Fa krb5_context context Fa const krb5_config_section *c Fa va_list args Fc Ft krb5_boolean Fo krb5_config_vget_bool_default Fa krb5_context context Fa const krb5_config_section *c Fa krb5_boolean def_value Fa va_list args Fc Ft int Fo krb5_config_vget_int Fa krb5_context context Fa const krb5_config_section *c Fa va_list args Fc Ft int Fo krb5_config_vget_int_default Fa krb5_context context Fa const krb5_config_section *c Fa int def_value Fa va_list args Fc Ft const krb5_config_binding * Fo krb5_config_vget_list Fa krb5_context context Fa const krb5_config_section *c Fa va_list args Fc Ft const void * Fo krb5_config_vget_next Fa krb5_context context Fa const krb5_config_section *c Fa const krb5_config_binding **pointer Fa int type Fa va_list args Fc Ft const char * Fo krb5_config_vget_string Fa krb5_context context Fa const krb5_config_section *c Fa va_list args Fc Ft const char * Fo krb5_config_vget_string_default Fa krb5_context context Fa const krb5_config_section *c Fa const char *def_value Fa va_list args Fc Ft char ** Fo krb5_config_vget_strings Fa krb5_context context Fa const krb5_config_section *c Fa va_list args Fc Ft int Fo krb5_config_vget_time Fa krb5_context context Fa const krb5_config_section *c Fa va_list args Fc Ft int Fo krb5_config_vget_time_default Fa krb5_context context Fa const krb5_config_section *c Fa int def_value Fa va_list args Fc

DESCRIPTION

These functions get values from the krb5.conf5 configuration file, or another configuration database specified by the Fa c parameter.

The variable arguments should be a list of strings naming each subsection to look for. For example:

krb5_config_get_bool_default(context, NULL, FALSE, 
     "libdefaults", "log_utc", NULL);

gets the boolean value for the log_utc option, defaulting to FALSE

Fn krb5_config_get_bool_default will convert the option value to a boolean value, where `yes' `true' and any non-zero number means TRUE and any other value FALSE

Fn krb5_config_get_int_default will convert the value to an integer.

Fn krb5_config_get_time_default will convert the value to a period of time (not a time stamp) in seconds, so the string `2 weeks' will be converted to 1209600 (2 * 7 * 24 * 60 * 60).

Fn krb5_config_get_string returns a Ft const char * to a string in the configuration database. The string may not be valid after a reload of the configuration database so a caller should make a local copy if it needs to keep the string.

Fn krb5_config_free_strings free Fa strings as returned by Fn krb5_config_get_strings and Fn krb5_config_vget_strings . If the argument Fa strings is a NULL pointer, no action occurs.

Fn krb5_config_file_free free the result of Fn krb5_config_parse_file and Fn krb5_config_parse_file_multi .

BUGS

For the default functions, other than for the string case, there's no way to tell whether there was a value specified or not.

This document was created by man2html, using the manual pages.
Time: 22:37:57 GMT, April 16, 2011