Version 5.0.1

[yaz-moved-to-github.git] / include / yaz / tpath.h

diff --git a/include/yaz/tpath.h b/include/yaz/tpath.h
index 59de466..9563c80 100644 (file)
--- a/include/yaz/tpath.h
+++ b/include/yaz/tpath.h
@@ -1,5 +1,5 @@
 /* This file is part of the YAZ toolkit.
 /* This file is part of the YAZ toolkit.

- * Copyright (C) 1995-2010 Index Data.
+ * Copyright (C) 1995-2013 Index Data.

  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:

@@ -43,14 +43,14 @@ YAZ_BEGIN_CDECL
     \retval 1 path is absolute
     \retval 0 path is relative
 */
     \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)
     \param comp upon pointer to component (if component is found)
     \retval 0 no component found (and no more componennts)
     \retval >0 length of component (length of *comp)
 
 /** \brief get next path component in filepath
     \param path_p pointer to path (updated to "next" entry if any)
     \param comp upon pointer to component (if component is found)
     \retval 0 no component found (and no more componennts)
     \retval >0 length of component (length of *comp)

-    
+

     A filepath has components separted by colon. For example
     /usr/lib/modules:c:/my:/:lib
     which has these components
     A filepath has components separted by colon. For example
     /usr/lib/modules:c:/my:/:lib
     which has these components

@@ -59,39 +59,34 @@ YAZ_EXPORT int yaz_is_abspath (const char *path);
 YAZ_EXPORT size_t yaz_filepath_comp(const char **path_p, const char **comp);
 
 
 YAZ_EXPORT size_t yaz_filepath_comp(const char **path_p, const char **comp);
 
 

-/** \brief resolve file on path 
+/** \brief resolve file on path

     \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 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);
 
 
 */
 YAZ_EXPORT char *yaz_filepath_resolve(const char *fname, const char *path,
                                       const char *base, char *fullpath);
 
 

-/** \brief opens first file in path in path 
+/** \brief opens first file in path in path

     \param fname "short" filename (without 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)
     \param fname "short" filename (without 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);
 
 */
 YAZ_EXPORT FILE *yaz_fopen(const char *path, const char *fname,
                            const char *mode, const char *base);
 

-/** \brief opens first file in path in path 
+/** \brief opens first file in path in path

     \param fname "short" filename (without path)
     \param mode mode as in fopen(3)
     \param path the path (dir1:dir2,..) - ala Unix
     \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);
 */
 YAZ_EXPORT FILE *yaz_path_fopen(const char *path, const char *fname,
                                 const char *mode);