canonicalize_file_name(3) — Linux manual page

canonical...file_name(3) Library Functions Manualcanonical...file_name(3)

NAME         top

       canonicalize_file_name - return the canonicalized absolute
       pathname

LIBRARY         top

       Standard C library (libc, -lc)

SYNOPSIS         top

       #define _GNU_SOURCE         /* See feature_test_macros(7) */
       #include <stdlib.h>

       char *canonicalize_file_name(const char *path);

DESCRIPTION         top

       The canonicalize_file_name() function returns a null-terminated
       string containing the canonicalized absolute pathname
       corresponding to path.  In the returned string, symbolic links are
       resolved, as are .  and ..  pathname components.  Consecutive
       slash (/) characters are replaced by a single slash.

       The returned string is dynamically allocated by
       canonicalize_file_name() and the caller should deallocate it with
       free(3) when it is no longer required.

       The call canonicalize_file_name(path) is equivalent to the call:

           realpath(path, NULL);

RETURN VALUE         top

       On success, canonicalize_file_name() returns a null-terminated
       string.  On error (e.g., a pathname component is unreadable or
       does not exist), canonicalize_file_name() returns NULL and sets
       errno to indicate the error.

ERRORS         top

       See realpath(3).

ATTRIBUTES         top

       For an explanation of the terms used in this section, see
       attributes(7).
       ┌──────────────────────────────────────┬───────────────┬─────────┐
       │ Interface                            │ Attribute     │ Value   │
       ├──────────────────────────────────────┼───────────────┼─────────┤
       │ canonicalize_file_name()             │ Thread safety │ MT-Safe │
       └──────────────────────────────────────┴───────────────┴─────────┘

STANDARDS         top

       GNU.

SEE ALSO         top

       readlink(2), realpath(3)

COLOPHON         top

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.10.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2025-02-02.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       man-pages@man7.org

Linux man-pages 6.10            2024-07-23       canonical...file_name(3)

Pages that refer to this page: realpath(3)

HTML rendering created 2025-02-02 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.