Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
minput_config_variable(3m17n)	 Version 1.5.5	 minput_config_variable(3m17n)

NAME
       minput_config_variable -	Configure the value of an input	method
       variable.

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

DESCRIPTION
       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().

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

       o value is not in a valid form, the type	does not match the definition,
	 or the	value is our of	range.
       o variable is not available for the input method.
       o language and name do not specify an existing input method.
SEE ALSO
	   minput_get_variable(), minput_save_config().
COPYRIGHT
       Copyright (C) 2001 Information-technology Promotion Agency (IPA)
       Copyright (C) 2001-2009 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>.

				  15 Oct 2009	 minput_config_variable(3m17n)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=minput_config_variable&sektion=3m17n&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help