--- name: "explain_symlink" section: "3" platform: "linux" package: "libexplain-dev" version: "1.4.D001-16" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/explain_symlink" --- # explain\_symlink(3) explain symlink(2) errors ## NAME explain\_symlink - explain [symlink(2)](/symlink/2.md) errors ## SYNOPSIS \#include \\ const char \*explain\_symlink(const char \*oldpath, const char \*newpath);\ const char \*explain\_errno\_symlink(int errnum, const char \*oldpath, const char \*newpath);\ void explain\_message\_symlink(char \*message, int message\_size, const char \*oldpath, const char \*newpath);\ void explain\_message\_errno\_symlink(char \*message, int message\_size, int errnum, const char \*oldpath, const char \*newpath); ## DESCRIPTION These functions may be used to obtain explanations for [*symlink*(2)](/symlink/2.md) errors. ### explain\_symlink const char \*explain\_symlink(const char \*oldpath, const char \*newpath); The explain\_symlink function is used to obtain an explanation of an error returned by the [*symlink*(2)](/symlink/2.md) system call. The least the message will contain is the value of `strerror(errno)`, but usually it will do much better, and indicate the underlying cause in more detail. The *errno* global variable will be used to obtain the error value to be decoded. This function is intended to be used in a fashion similar to the following example: ``` if (symlink(oldpath, rewpath) < 0) { fprintf(stderr, '%s0, explain_symlink(oldpath, newpath)); exit(EXIT_FAILURE); } ``` - *oldpath* The original oldpath, exactly as passed to the [*symlink*(2)](/symlink/2.md) system call. - *newpath* The original newpath, exactly as passed to the [*symlink*(2)](/symlink/2.md) system call. - Returns: The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads. **Note:** This function is **not** thread safe, because it shares a return buffer across all threads, and many other functions in this library. ### explain\_errno\_symlink const char \*explain\_errno\_symlink(int errnum, const char \*oldpath, const char \* newpath); The explain\_errno\_symlink function is used to obtain an explanation of an error returned by the [*symlink*(2)](/symlink/2.md) system call. The least the message will contain is the value of `strerror(errnum)`, but usually it will do much better, and indicate the underlying cause in more detail. This function is intended to be used in a fashion similar to the following example: ``` if (symlink(oldpath, newpath) < 0) { int err = errno; fprintf(stderr, '%s0, explain_errno_symlink(err, oldpath, newpath)); exit(EXIT_FAILURE); } ``` - *errnum* The error value to be decoded, usually obtained from the *errno* global variable just before this function is called. This is necessary if you need to call **any** code between the system call to be explained and this function, because many libc functions will alter the value of *errno*. - *oldpath* The original oldpath, exactly as passed to the [*symlink*(2)](/symlink/2.md) system call. - *newpath* The original newpath, exactly as passed to the [*symlink*(2)](/symlink/2.md) system call. - Returns: The message explaining the error. This message buffer is shared by all libexplain functions which do not supply a buffer in their argument list. This will be overwritten by the next call to any libexplain function which shares this buffer, including other threads. **Note:** This function is **not** thread safe, because it shares a return buffer across all threads, and many other functions in this library. ### explain\_message\_symlink void explain\_message\_symlink(char \*message, int message\_size, const char \*oldpath, const char \*newpath); The explain\_message\_symlink function is used to obtain an explanation of an error returned by the [*symlink*(2)](/symlink/2.md) system call. The least the message will contain is the value of `strerror(errno)`, but usually it will do much better, and indicate the underlying cause in more detail. The *errno\]fP global variable will be used to obtain the error value* *to be decoded.* *This function is intended to be used in a fashion similar to the* *following example:* ``` if (symlink(oldpath, newpath) < 0) { char message[3000]; explain_message_symlink(message, sizeof(message), oldpath, newpath); fprintf(stderr, '%s0, message); exit(EXIT_FAILURE); } ``` - *message* The location in which to store the returned message. Because a message return buffer has been supplied, this function is thread safe. - *message\_size* The size in bytes of the location in which to store the returned message. - *oldpath* The original oldpath, exactly as passed to the [*symlink*(2)](/symlink/2.md) system call. - *newpath* The original newpath, exactly as passed to the [*symlink*(2)](/symlink/2.md) system call. ### explain\_message\_errno\_symlink void explain\_message\_errno\_symlink(char \*message, int message\_size, int errnum, const char \*oldpath, const char \*newpath); The explain\_message\_errno\_symlink function is used to obtain an explanation of an error returned by the [*symlink*(2)](/symlink/2.md) system call. The least the message will contain is the value of `strerror(errnum)`, but usually it will do much better, and indicate the underlying cause in more detail. This function is intended to be used in a fashion similar to the following example: ``` if (symlink(oldpath, newpath) < 0) { int err = errno; char message[3000]; explain_message_errno_symlink(message, sizeof(message), err, oldpath, newpath); fprintf(stderr, '%s0, message); exit(EXIT_FAILURE); } ``` - *message* The location in which to store the returned message. Because a message return buffer has been supplied, this function is thread safe. - *message\_size* The size in bytes of the location in which to store the returned message. - *errnum* The error value to be decoded, usually obtained from the *errno* global variable just before this function is called. This is necessary if you need to call **any** code between the system call to be explained and this function, because many libc functions will alter the value of *errno*. - *oldpath* The original oldpath, exactly as passed to the [*symlink*(2)](/symlink/2.md) system call. - *newpath* The original newpath, exactly as passed to the [*symlink*(2)](/symlink/2.md) system call. ## COPYRIGHT libexplain version 1.4\ Copyright (C) 2008 Peter Miller ## AUTHOR Written by Peter Miller \