X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Ftpath.h;h=b135ce42334a76461c2fe03430be9e0149f458b9;hp=da145dca982a121ab638afade15202794d757201;hb=df65074917a6504ab9f21b5d1897b006ec086007;hpb=43a9d38d20c1b1bcd1a03b2445a501d27526bd35 diff --git a/include/yaz/tpath.h b/include/yaz/tpath.h index da145dc..b135ce4 100644 --- a/include/yaz/tpath.h +++ b/include/yaz/tpath.h @@ -43,7 +43,7 @@ YAZ_BEGIN_CDECL \retval 1 path is absolute \retval 0 path is relative */ -YAZ_EXPORT int yaz_is_abspath (const char *path); +YAZ_EXPORT int yaz_is_abspath(const char *path); /** \brief get next path component in filepath \param path_p pointer to path (updated to "next" entry if any) @@ -63,11 +63,10 @@ YAZ_EXPORT size_t yaz_filepath_comp(const char **path_p, const char **comp); \param fname "short" filename (without path) \param path the path (dir1:dir2,..) - ala Unix \param base can be added to relative paths (NULL for no append) - \param fullpath the full path to filename (if succesful) + \param fullpath the full path to filename (if successful) + \returns fullpath or NULL if file could not be found - Returns 0/NULL if no fname could be found in path; - pointer to fullpath if fname could be found. - We assume fullpath is 1024 bytes in length! + Be sure to allocate at least 1024 bytes for fullpath */ YAZ_EXPORT char *yaz_filepath_resolve(const char *fname, const char *path, const char *base, char *fullpath); @@ -78,9 +77,7 @@ YAZ_EXPORT char *yaz_filepath_resolve(const char *fname, const char *path, \param mode mode as in fopen(3) \param path the path (dir1:dir2,..) - ala Unix \param base can be added to relative paths (NULL for no append) - - Returns 0/NULL if no fname could be found in path; - FILE pointer if fname could be found. + \returns FILE pointer if fname could be found; NULL otherwise */ YAZ_EXPORT FILE *yaz_fopen(const char *path, const char *fname, const char *mode, const char *base); @@ -89,9 +86,7 @@ YAZ_EXPORT FILE *yaz_fopen(const char *path, const char *fname, \param fname "short" filename (without path) \param mode mode as in fopen(3) \param path the path (dir1:dir2,..) - ala Unix - - Returns 0/NULL if no fname could be found in path; - FILE pointer if fname could be found. + \returns FILE pointer if fname could be found; NULL otherwise */ YAZ_EXPORT FILE *yaz_path_fopen(const char *path, const char *fname, const char *mode);