The function new_item allocates a new item and initializes
- it from the name and description pointers. Please notice
- that the item stores only the pointers to the name and
+ it from the name and description pointers. Please notice
+ that the item stores only the pointers to the name and
description. Those pointers must be valid during the life-
time of the item. So you should be very careful with names
or descriptions allocated on the stack of some routines.
The function free_item de-allocates an item. Please notice
- that it is the responsibility of the application to
- release the memory for the name or the description of the
+ that it is the responsibility of the application to
+ release the memory for the name or the description of the
item.
-
+ The function new_item returns NULL on error. It sets
+ errno according to the function's failure:
+
+ E_BAD_ARGUMENT
+ Routine detected an incorrect or out-of-range argu-
+ ment.
+
+ E_SYSTEM_ERROR
+ System error occurred, e.g., malloc failure.
The function free_item returns one of the following:
E_OK The routine succeeded.
- E_SYSTEM_ERROR
- System error occurred (see errno).
-
E_BAD_ARGUMENT
- Routine detected an incorrect or out-of-range argu-
+ Routine detected an incorrect or out-of-range argu-
ment.
E_CONNECTED
Item is connected to a menu.
+ E_SYSTEM_ERROR
+ System error occurred (see errno).
+
-