doc/man/econf_getPath.3 - master - githubmirror/libeconf

doc/man/econf_getPath.3
74 строки2 KB
Stefan Schubert
Split man pages (#244)
08 дек 2025, 18:12
08 дек 2025, 18:128b8507b
'\" t
.\"     Title: ECONF_GETPATH
.\"    Author: libeconf developers
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 2024-12-04
.\"    Manual: libeconf Manual
.\"    Source: libeconf
.\"  Language: English
.\"
.TH "ECONF_GETPATH" "3" "2024\-12\-04" "libeconf" "libeconf Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------

.SH "NAME"
econf_getPath \- evaluate path name of the configuration file

.SH "SYNOPSIS"

.sp
.ft B
.nf
#include <libeconf\&.h>
.fi
.ft
.sp

.BI "char *econf_getPath(econf_file\ *" "kf" ");"

.SH "DESCRIPTION"

.PP
The \fBeconf_getPath\fR() function returns the absolute path name of the configuration file associated with the \fIkf\fR object\&.

.PP
This is useful when the \fIkf\fR object was created via functions that read from disk, such as \fBeconf_readFile\fR(), to identify the origin of the configuration data\&.

.SH "RETURN VALUE"

.PP
Upon successful completion, \fBeconf_getPath\fR() returns a pointer to a null\-terminated string containing the absolute path of the file\&.

.PP
If \fIkf\fR is NULL, or if the \fIkf\fR object represents already merged data (for example, result of \fBeconf_readConfig\fR() or \fBeconf_mergeFiles\fR()), the function returns an empty string,

.SH "ERRORS"

.PP
As this function returns a string pointer, it does not return
\fBeconf_err\fR codes\&. However, it may return an empty string
if the input is invalid or no path is associated\&.

.SH "SEE ALSO"

.PP
\fBeconf_readFile\fR(3),
\fBeconf_readConfig\fR(3),
\fBlibeconf\fR(3)