include/yaz/record_render.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2013 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /**
  29  * \file record_render.h
  30  * \brief Record render header
  31  */
  32
  33 #ifndef YAZ_RECORD_RENDER_H
  34 #define YAZ_RECORD_RENDER_H
  35
  36 #include <stddef.h>
  37 #include <yaz/yconfig.h>
  38 #include <yaz/z-core.h>
  39 #include <yaz/wrbuf.h>
  40
  41 YAZ_BEGIN_CDECL
  42
  43 /** \brief render records (ZOOM style)
  44     \param npr record structure to be rendered (Z39.50)
  45     \param schema for record (if known)
  46     \param wrbuf Working WRBUF
  47     \param type_spec format spec
  48     \param len length of returned buffer
  49     \retval !=0 buffer
  50     \retval =0 record could not be rendered
  51
  52     txml; charset=marc-8
  53     xml; charset=utf-8
  54     txml; charset=marc-8; base64=/rec/my/text()
  55 */
  56 YAZ_EXPORT
  57 const char *yaz_record_render(Z_NamePlusRecord *npr, const char *schema,
  58                               WRBUF wrbuf,
  59                               const char *type_spec, int *len);
  60
  61 YAZ_END_CDECL
  62
  63 #endif
  64 /*
  65  * Local variables:
  66  * c-basic-offset: 4
  67  * c-file-style: "Stroustrup"
  68  * indent-tabs-mode: nil
  69  * End:
  70  * vim: shiftwidth=4 tabstop=8 expandtab
  71  */
  72