<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libfishsound: comments.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>comments.h</h1><a href="comments_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2003 Commonwealth Scientific and Industrial Research</span>
<a name="l00003"></a>00003 <span class="comment"> Organisation (CSIRO) Australia</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment"> Redistribution and use in source and binary forms, with or without</span>
<a name="l00006"></a>00006 <span class="comment"> modification, are permitted provided that the following conditions</span>
<a name="l00007"></a>00007 <span class="comment"> are met:</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> - Redistributions of source code must retain the above copyright</span>
<a name="l00010"></a>00010 <span class="comment"> notice, this list of conditions and the following disclaimer.</span>
<a name="l00011"></a>00011 <span class="comment"></span>
<a name="l00012"></a>00012 <span class="comment"> - Redistributions in binary form must reproduce the above copyright</span>
<a name="l00013"></a>00013 <span class="comment"> notice, this list of conditions and the following disclaimer in the</span>
<a name="l00014"></a>00014 <span class="comment"> documentation and/or other materials provided with the distribution.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment"> - Neither the name of CSIRO Australia nor the names of its</span>
<a name="l00017"></a>00017 <span class="comment"> contributors may be used to endorse or promote products derived from</span>
<a name="l00018"></a>00018 <span class="comment"> this software without specific prior written permission.</span>
<a name="l00019"></a>00019 <span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment"> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span>
<a name="l00021"></a>00021 <span class="comment"> ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span>
<a name="l00022"></a>00022 <span class="comment"> LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A</span>
<a name="l00023"></a>00023 <span class="comment"> PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR</span>
<a name="l00024"></a>00024 <span class="comment"> CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span>
<a name="l00025"></a>00025 <span class="comment"> EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span>
<a name="l00026"></a>00026 <span class="comment"> PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</span>
<a name="l00027"></a>00027 <span class="comment"> PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF</span>
<a name="l00028"></a>00028 <span class="comment"> LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</span>
<a name="l00029"></a>00029 <span class="comment"> NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span>
<a name="l00030"></a>00030 <span class="comment"> SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
<a name="l00031"></a>00031 <span class="comment">*/</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="preprocessor">#ifndef __FISH_SOUND_COMMENT_H__</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#define __FISH_SOUND_COMMENT_H__</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span>
<a name="l00087"></a>00087 <span class="preprocessor">#include <<a class="code" href="fishsound_8h.html" title="The libfishsound C API.">fishsound/fishsound.h</a>></span>
<a name="l00088"></a>00088
<a name="l00092"></a><a class="code" href="structFishSoundComment.html">00092</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
<a name="l00094"></a><a class="code" href="structFishSoundComment.html#ededfdcebf50dc81cce9d714e5cda6df">00094</a> <span class="keywordtype">char</span> * name;
<a name="l00095"></a>00095
<a name="l00097"></a><a class="code" href="structFishSoundComment.html#4293f69fe0e695fc9102e1667ce9add1">00097</a> <span class="keywordtype">char</span> * value;
<a name="l00098"></a>00098 } <a class="code" href="structFishSoundComment.html" title="A comment.">FishSoundComment</a>;
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00101"></a>00101 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00102"></a>00102 <span class="preprocessor">#endif</span>
<a name="l00103"></a>00103 <span class="preprocessor"></span>
<a name="l00111"></a>00111 <span class="keyword">const</span> <span class="keywordtype">char</span> *
<a name="l00112"></a>00112 <a class="code" href="comments_8h.html#ecaa4422dade26c02553ba48697503ad" title="Retrieve the vendor string.">fish_sound_comment_get_vendor</a> (<a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * fsound);
<a name="l00113"></a>00113
<a name="l00114"></a>00114
<a name="l00121"></a>00121 <span class="keyword">const</span> <a class="code" href="structFishSoundComment.html" title="A comment.">FishSoundComment</a> *
<a name="l00122"></a>00122 <a class="code" href="comments_8h.html#1f0118f390450b28b19bd61ebb6cb7a3" title="Retrieve the first comment.">fish_sound_comment_first</a> (<a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * fsound);
<a name="l00123"></a>00123
<a name="l00131"></a>00131 <span class="keyword">const</span> <a class="code" href="structFishSoundComment.html" title="A comment.">FishSoundComment</a> *
<a name="l00132"></a>00132 <a class="code" href="comments_8h.html#b68a529900d2546075193fa37cba76c8" title="Retrieve the next comment.">fish_sound_comment_next</a> (<a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * fsound, <span class="keyword">const</span> <a class="code" href="structFishSoundComment.html" title="A comment.">FishSoundComment</a> * comment);
<a name="l00133"></a>00133
<a name="l00143"></a>00143 <span class="keyword">const</span> <a class="code" href="structFishSoundComment.html" title="A comment.">FishSoundComment</a> *
<a name="l00144"></a>00144 <a class="code" href="comments_8h.html#8d4404ac25bc87a08bdd64cccb27f934" title="Retrieve the first comment with a given name.">fish_sound_comment_first_byname</a> (<a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * fsound, <span class="keywordtype">char</span> * name);
<a name="l00145"></a>00145
<a name="l00156"></a>00156 <span class="keyword">const</span> <a class="code" href="structFishSoundComment.html" title="A comment.">FishSoundComment</a> *
<a name="l00157"></a>00157 <a class="code" href="comments_8h.html#7a57c6059a0c2c8b10cf655d78977940" title="Retrieve the next comment following and with the same name as a given comment.">fish_sound_comment_next_byname</a> (<a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * fsound,
<a name="l00158"></a>00158 <span class="keyword">const</span> <a class="code" href="structFishSoundComment.html" title="A comment.">FishSoundComment</a> * comment);
<a name="l00159"></a>00159
<a name="l00168"></a>00168 <span class="keywordtype">int</span>
<a name="l00169"></a>00169 <a class="code" href="comments_8h.html#77493e66f0e4ce8870f6f5413b90317e" title="Add a comment.">fish_sound_comment_add</a> (<a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * fsound, <a class="code" href="structFishSoundComment.html" title="A comment.">FishSoundComment</a> * comment);
<a name="l00170"></a>00170
<a name="l00180"></a>00180 <span class="keywordtype">int</span>
<a name="l00181"></a>00181 <a class="code" href="comments_8h.html#ef6ec7d8894aac5da78cb0f5711e7d67" title="Add a comment by name and value.">fish_sound_comment_add_byname</a> (<a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * fsound, <span class="keyword">const</span> <span class="keywordtype">char</span> * name,
<a name="l00182"></a>00182 <span class="keyword">const</span> <span class="keywordtype">char</span> * value);
<a name="l00183"></a>00183
<a name="l00193"></a>00193 <span class="keywordtype">int</span>
<a name="l00194"></a>00194 <a class="code" href="comments_8h.html#d6c456b3c1f943966d1bac04452b2e84" title="Remove a comment.">fish_sound_comment_remove</a> (<a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * fsound, <a class="code" href="structFishSoundComment.html" title="A comment.">FishSoundComment</a> * comment);
<a name="l00195"></a>00195
<a name="l00204"></a>00204 <span class="keywordtype">int</span>
<a name="l00205"></a>00205 <a class="code" href="comments_8h.html#5a84f90f4f3d61acd7682675b874a359" title="Remove all comments with a given name.">fish_sound_comment_remove_byname</a> (<a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * fsound, <span class="keywordtype">char</span> * name);
<a name="l00206"></a>00206
<a name="l00207"></a>00207 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00208"></a>00208 <span class="preprocessor"></span>}
<a name="l00209"></a>00209 <span class="preprocessor">#endif</span>
<a name="l00210"></a>00210 <span class="preprocessor"></span>
<a name="l00211"></a>00211 <span class="preprocessor">#endif </span><span class="comment">/* __FISH_SOUND_COMMENTS_H__ */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 3 22:16:44 2010 for libfishsound by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
