DOKK / manpages / debian 10 / m17n-docs / minput_config_variable.3m17n.en
minput_config_variable(3m17n) The m17n Library minput_config_variable(3m17n)

minput_config_variable - Configure the value of an input method variable.

int minput_config_variable (MSymbol language, MSymbol name, MSymbol variable, MPlist * value)

Configure the value of an input method variable. The minput_config_variable() function assigns value to the variable variable of the input method specified by language and name.

If value is a non-empty plist, it must be a plist of one element whose key is Minteger, Msymbol, or Mtext, and the value is of the corresponding type. That value is assigned to the variable.

If value is an empty plist, any configuration and customization of the variable are canceled, and the default value is assigned to the variable.

If value is NULL, the configuration of the variable is canceled, and the original value (what saved in per-user customization file, or the default value) is assigned to the variable.

In the latter two cases, variable can be Mnil to make all the variables of the input method the target of the operation.

If name is Mnil, this function configures the value of global variable, not that of a specific input method.

The configuration takes effect for input methods opened or re-opened later in the current session. To make the configuration take effect for the future session, it must be saved in a per-user customization file by the function minput_save_config().

If the operation was successful, this function returns 0, otherwise returns -1. The operation fails in these cases:

  • value is not in a valid form, the type does not match the definition, or the value is our of range.
  • variable is not available for the input method.
  • language and name do not specify an existing input method.

minput_get_variable(), minput_save_config().

Copyright (C) 2001 Information-technology Promotion Agency (IPA)
Copyright (C) 2001-2011 National Institute of Advanced Industrial Science and Technology (AIST)
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License <http://www.gnu.org/licenses/fdl.html>.

12 Jan 2011 Version 1.6.2