freelocale - Man Page

free resources allocated for a locale object

Prolog

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux.

Synopsis

#include <locale.h>

void freelocale(locale_t locobj);

Description

The freelocale() function shall cause the resources allocated for a locale object returned by a call to the newlocale() or duplocale() functions to be released.

The behavior is undefined if the locobj argument is the special locale object LC_GLOBAL_LOCALE or is not a valid locale object handle.

Any use of a locale object that has been freed results in undefined behavior.

Return Value

None.

Errors

None.

The following sections are informative.

Examples

Freeing Up a Locale Object

The following example shows a code fragment to free a locale object created by newlocale():

#include <locale.h>
...

/* Every locale object allocated with newlocale() should be
 * freed using freelocale():
 */

locale_t loc;

/* Get the locale. */

loc = newlocale (LC_CTYPE_MASK | LC_TIME_MASK, "locname", NULL);

/* ... Use the locale object ... */
...

/* Free the locale object resources. */
freelocale (loc);

Application Usage

None.

Rationale

None.

Future Directions

None.

See Also

duplocale(), newlocale(), uselocale()

The Base Definitions volume of POSIX.1-2017, <locale.h>

Referenced By

duplocale(3p), locale.h(0p), newlocale(3p), uselocale(3p).

2017 IEEE/The Open Group POSIX Programmer's Manual