diff options
| author | Iker Pedrosa <ipedrosa@redhat.com> | 2022-07-05 14:57:05 +0200 |
|---|---|---|
| committer | Dmitry V. Levin <ldv@altlinux.org> | 2022-07-15 08:00:00 +0000 |
| commit | 37c8403dbefe9b0f1cb22b1a96c30d926fd568c8 (patch) | |
| tree | 3d962730554b42eadcfe9c1501e55e98ef084961 /libpam/include | |
| parent | 37b47c08ce9127e23bc26a79c2f715daf8466f50 (diff) | |
| download | pam-37c8403dbefe9b0f1cb22b1a96c30d926fd568c8.tar.gz pam-37c8403dbefe9b0f1cb22b1a96c30d926fd568c8.tar.bz2 pam-37c8403dbefe9b0f1cb22b1a96c30d926fd568c8.zip | |
libpam: improve pam_modutil_search_key() doc
* libpam/include/security/pam_modutil.h: Improve the
pam_modutil_search_key() interface documentation.
Signed-off-by: Iker Pedrosa <ipedrosa@redhat.com>
Diffstat (limited to 'libpam/include')
| -rw-r--r-- | libpam/include/security/pam_modutil.h | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/libpam/include/security/pam_modutil.h b/libpam/include/security/pam_modutil.h index 33f87b90..c2578323 100644 --- a/libpam/include/security/pam_modutil.h +++ b/libpam/include/security/pam_modutil.h @@ -147,7 +147,16 @@ pam_modutil_sanitize_helper_fds(pam_handle_t *pamh, enum pam_modutil_redirect_fd redirect_stdout, enum pam_modutil_redirect_fd redirect_stderr); -/* lookup a value for key in login.defs file or similar key value format */ +/************************************************** + * @brief Lookup a value for the key in the file (i.e. login.defs or a similar + * key-value format file). + * + * @param[in] pamh The pam handle structure + * @param[in] file_name Configuration file name + * @param[in] key Lookup key + * + * @return value, or NULL if key was not found. + **************************************************/ extern char * PAM_NONNULL((1,2,3)) pam_modutil_search_key(pam_handle_t *pamh, const char *file_name, |