Version 5.0.1

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

diff --git a/include/yaz/retrieval.h b/include/yaz/retrieval.h
index 4736a47..04526b1 100644 (file)
--- a/include/yaz/retrieval.h
+++ b/include/yaz/retrieval.h
@@ -1,5 +1,5 @@
 /* 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:
@@ -61,8 +61,8 @@ YAZ_EXPORT void yaz_retrieval_destroy(yaz_retrieval_t p);
     \retval 0 success
     \retval -1 failure
 
-    On failure, use yaz_retrieval_get_error to get error string.
-    
+    On failure, call yaz_retrieval_get_error to get error string.
+
     For retrieval:
     \verbatim
      <retrievalinfo>
@@ -87,6 +87,21 @@ YAZ_EXPORT void yaz_retrieval_destroy(yaz_retrieval_t p);
 */
 YAZ_EXPORT
 int yaz_retrieval_configure(yaz_retrieval_t p, const xmlNode *node);
+
+
+/** configures retrieval with user-defined conversion types
+    \param p retrieval handle
+    \param node xmlNode pointer (root element of XML config)
+    \param types record conversion types
+    \retval 0 success
+    \retval -1 failure
+
+    On failure, use yaz_retrieval_get_error to get error string.
+*/
+YAZ_EXPORT
+int yaz_retrieval_configure_t(yaz_retrieval_t p, const xmlNode *node,
+                              struct yaz_record_conv_type *types);
+
 #endif
 
 /** performs retrieval request based on schema and format
@@ -115,7 +130,7 @@ int yaz_retrieval_request(yaz_retrieval_t p,
 /** returns error string (for last error)
     \param p record conversion handle
     \return error string
-*/    
+*/
 YAZ_EXPORT
 const char *yaz_retrieval_get_error(yaz_retrieval_t p);
 
@@ -123,7 +138,7 @@ const char *yaz_retrieval_get_error(yaz_retrieval_t p);
 /** set path for opening stylesheets etc.
     \param p record conversion handle
     \param path file path (UNIX style with : / Windows with ;)
-*/    
+*/
 YAZ_EXPORT
 void yaz_retrieval_set_path(yaz_retrieval_t p, const char *path);