1. NAME

XkbFreeGeomKeyAliases - Free geometry key aliases

2. SYNOPSIS

void XkbFreeGeomKeyAliases (XkbGeometryPtr geom , int first , int count , Bool free_all );

3. ARGUMENTS

  • - geom
        geometry in which key aliases should be freed
  • - first
        first key alias to be freed
  • - count
        number of key aliases to be freed
  • - free_all
        True => all key aliases are freed

4. DESCRIPTION

Xkb provides a number of functions to allocate and free subcomponents of a keyboard geometry. Use these functions to create or modify keyboard geometries. Note that these functions merely allocate space for the new element(s), and it is up to you to fill in the values explicitly in your code. These allocation functions increase sz_*but never touch num_*(unless there is an allocation failure, in which case they reset both sz_*and num_*to zero). These functions return Success if they succeed, BadAlloc if they are not able to allocate space, or BadValue if a parameter is not as expected. If free_allis True, all aliases in the top level of the specified geometry geomare freed regardless of the value of firstor count.Otherwise, countaliases in geomare freed beginning with the one specified by first.

5. RETURN VALUES

  • Success
                   The XkbFreeGeomKeyAliases function returns Success if there are no allocation errors.

6. DIAGNOSTICS

BadAlloc

               Unable to allocate storage

BadValue

               An argument is out of range