Deprecated¶

This page documents the deprecated functions in the Argtable3 library. These functions are retained for backward compatibility but are no longer recommended for use in new applications. Developers are encouraged to use the newer, more robust alternatives provided by the library.

Deprecation indicates that these functions may be removed in future releases, so transitioning to the recommended alternatives is advised to ensure long-term compatibility and maintainability of your code.

Below is a reference for the deprecated functions in the Argtable3 API.

API¶

void arg_free(void **argtable)¶

Deallocates or frees non-null entries of the argument table.

The arg_free function is deprecated in favour of the arg_freetable function due to a flaw in its design. The flaw results in memory leak in the (very rare) case that an intermediate entry in the argtable array failed its memory allocation while others following that entry were still allocated ok. Those subsequent allocations will not be deallocated by arg_free.

Despite the unlikeliness of the problem occurring, and the even unlikelier event that it has any deliterious effect, it is fixed regardless by replacing arg_free with the newer arg_freetable function. We still keep arg_free for backwards compatibility.

Deprecated:: Use arg_freetable instead.

Parameters:

argtable – An array of argument table structs.