7.3.17. config_get#

7.3.17.1. Summary#

New in version 5.1.2.

config_get command returns the value of the specified configuration item.

7.3.17.2. Syntax#

This command takes only one required parameter:

config_get key

7.3.17.3. Usage#

Here is an example to set a value to alias.column configuration item and get the value:

Execution example:

config_set alias.column Aliases.real_name
# [[0,1337566253.89858,0.000355720520019531],true]
config_get alias.column
# [[0,1337566253.89858,0.000355720520019531],"Aliases.real_name"]

Here is an example to get nonexistent configuration item value:

Execution example:

config_get nonexistent
# [[0,1337566253.89858,0.000355720520019531],""]

config_get returns an empty string for nonexistent configuration item key.

7.3.17.4. Parameters#

This section describes all parameters.

7.3.17.4.1. Required parameters#

There is only one required parameter.

7.3.17.4.1.1. key#

Specifies the key of target configuration item.

The max key size is 4KiB.

You can’t use an empty string as key.

7.3.17.4.2. Optional parameters#

There is no optional parameter.

7.3.17.5. Return value#

config_get command returns the value of the specified configuration item:

[HEADER, VALUE]

7.3.17.5.2. VALUE#

VALUE is the value of the configuration item specified by key. It’s a string.

7.3.17.6. See also#