XkbFreeGeomDoodads (3)
Leading comments
Copyright 1999 Oracle and/or its affiliates. All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following condition...
NAME
XkbFreeGeomDoodads - Free geometry doodadsSYNOPSIS
-
void XkbFreeGeomDoodads
(XkbDoodadPtr doodads,
int count,
Bool free_all);
ARGUMENTS
- - doodads
-
- doodads to be freed
- - count
- number of doodads to be freed
- - free_all
- True => all doodads are freed
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_all
is True, all doodads in the array are freed, regardless of the value of
count.
Otherwise,
count
doodads are freed.
RETURN VALUES
- Success
- The XkbFreeGeomDoodads function returns Success if there are no allocation errors.
DIAGNOSTICS
- BadAlloc
- Unable to allocate storage
- BadValue
-
An argument is out of range