logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

duplocale.3p (4243B)

    

  1. '\" et
  2. .TH DUPLOCALE "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. duplocale
  12. \(em duplicate a locale object
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <locale.h>
  17. .P
  18. locale_t duplocale(locale_t \fIlocobj\fP);
  19. .fi
  20. .SH DESCRIPTION
  21. The
  22. \fIduplocale\fR()
  23. function shall create a duplicate copy of the locale object referenced
  24. by the
  25. .IR locobj
  26. argument.
  27. .P
  28. If the
  29. .IR locobj
  30. argument is LC_GLOBAL_LOCALE,
  31. \fIduplocale\fR()
  32. shall create a new locale object containing a copy of the global locale
  33. determined by the
  34. \fIsetlocale\fR()
  35. function.
  36. .P
  37. The behavior is undefined if the
  38. .IR locobj
  39. argument is not a valid locale object handle.
  40. .SH "RETURN VALUE"
  41. Upon successful completion, the
  42. \fIduplocale\fR()
  43. function shall return a handle for a new locale object. Otherwise,
  44. \fIduplocale\fR()
  45. shall return (\c
  46. .BR locale_t )0
  47. and set
  48. .IR errno
  49. to indicate the error.
  50. .SH ERRORS
  51. The
  52. \fIduplocale\fR()
  53. function shall fail if:
  54. .TP
  55. .BR ENOMEM
  56. There is not enough memory available to create the locale object or
  57. load the locale data.
  58. .LP
  59. .IR "The following sections are informative."
  60. .SH EXAMPLES
  61. .SS "Constructing an Altered Version of an Existing Locale Object"
  62. .P
  63. The following example shows a code fragment to create a slightly
  64. altered version of an existing locale object. The function takes a
  65. locale object and a locale name and it replaces the
  66. .IR LC_TIME
  67. category data in the locale object with that from the named locale.
  68. .sp
  69. .RS 4
  70. .nf
  72. #include <locale.h>
  73. \&...
  74. .P
  75. locale_t
  76. with_changed_lc_time (locale_t obj, const char *name)
  77. {
  78. .P
  79.     locale_t retval = duplocale (obj);
  80.     if (retval != (locale_t) 0)
  81.     {
  82.         locale_t changed = newlocale (LC_TIME_MASK, name, retval);
  83.         if (changed == (locale_t) 0)
  84.             /* An error occurred. Free all allocated resources. */
  85.             freelocale (retval);
  86.         retval = changed;
  87.     }
  88.     return retval;
  89. }
  90. .fi
  91. .P
  92. .RE
  93. .SH "APPLICATION USAGE"
  94. The use of the
  95. \fIduplocale\fR()
  96. function is recommended for situations where a locale object is being
  97. used in multiple places, and it is possible that the lifetime of the
  98. locale object might end before all uses are finished. Another reason to
  99. duplicate a locale object is if a slightly modified form is needed.
  100. This can be achieved by a call to
  101. \fInewlocale\fR()
  102. following the
  103. \fIduplocale\fR()
  104. call.
  105. .P
  106. As with the
  107. \fInewlocale\fR()
  108. function, handles for locale objects created by the
  109. \fIduplocale\fR()
  110. function should be released by a corresponding call to
  111. \fIfreelocale\fR().
  112. .P
  113. The
  114. \fIduplocale\fR()
  115. function can also be used in conjunction with
  116. .IR uselocale ((\c
  117. .BR locale_t )0).
  118. This returns the locale in effect for the calling thread, but can have
  119. the value LC_GLOBAL_LOCALE. Passing LC_GLOBAL_LOCALE to functions such as
  120. \fIisalnum_l\fR()
  121. results in undefined behavior, but applications can convert it into a
  122. usable locale object by using
  123. \fIduplocale\fR().
  124. .SH RATIONALE
  125. None.
  126. .SH "FUTURE DIRECTIONS"
  127. None.
  128. .SH "SEE ALSO"
  129. .IR "\fIfreelocale\fR\^(\|)",
  130. .IR "\fInewlocale\fR\^(\|)",
  131. .IR "\fIuselocale\fR\^(\|)"
  132. .P
  133. The Base Definitions volume of POSIX.1\(hy2017,
  134. .IR "\fB<locale.h>\fP"
  135. .\"
  136. .SH COPYRIGHT
  137. Portions of this text are reprinted and reproduced in electronic form
  138. from IEEE Std 1003.1-2017, Standard for Information Technology
  139. -- Portable Operating System Interface (POSIX), The Open Group Base
  140. Specifications Issue 7, 2018 Edition,
  141. Copyright (C) 2018 by the Institute of
  142. Electrical and Electronics Engineers, Inc and The Open Group.
  143. In the event of any discrepancy between this version and the original IEEE and
  144. The Open Group Standard, the original IEEE and The Open Group Standard
  145. is the referee document. The original Standard can be obtained online at
  146. http://www.opengroup.org/unix/online.html .
  147. .PP
  148. Any typographical or formatting errors that appear
  149. in this page are most likely
  150. to have been introduced during the conversion of the source files to
  151. man page format. To report such errors, see
  152. https://www.kernel.org/doc/man-pages/reporting_bugs.html .