libfishsound: comments.h Source File

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

# comments.h

Go to the documentation of this file.

    00001 /*
    00002    Copyright (C) 2003 Commonwealth Scientific and Industrial Research
    00003    Organisation (CSIRO) Australia
    00004
    00005    Redistribution and use in source and binary forms, with or without
    00006    modification, are permitted provided that the following conditions
    00007    are met:
    00008
    00009    - Redistributions of source code must retain the above copyright
    00010    notice, this list of conditions and the following disclaimer.
    00011
    00012    - Redistributions in binary form must reproduce the above copyright
    00013    notice, this list of conditions and the following disclaimer in the
    00014    documentation and/or other materials provided with the distribution.
    00015
    00016    - Neither the name of CSIRO Australia nor the names of its
    00017    contributors may be used to endorse or promote products derived from
    00018    this software without specific prior written permission.
    00019
    00020    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    00021    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    00022    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
    00023    PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE ORGANISATION OR
    00024    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
    00025    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
    00026    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
    00027    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
    00028    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
    00029    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    00030    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    00031 */
    00032
    00033 #ifndef __FISH_SOUND_COMMENT_H__
    00034 #define __FISH_SOUND_COMMENT_H__
    00035
    00087 #include <fishsound/fishsound.h>
    00088
    00092 typedef struct {
    00094   char * name;
    00095
    00097   char * value;
    00098 } FishSoundComment;
    00099
    00100 #ifdef __cplusplus
    00101 extern "C" {
    00102 #endif
    00103
    00111 const char *
    00112 fish_sound_comment_get_vendor (FishSound * fsound);
    00113
    00114
    00121 const FishSoundComment *
    00122 fish_sound_comment_first (FishSound * fsound);
    00123
    00131 const FishSoundComment *
    00132 fish_sound_comment_next (FishSound * fsound, const FishSoundComment * comment);
    00133
    00143 const FishSoundComment *
    00144 fish_sound_comment_first_byname (FishSound * fsound, char * name);
    00145
    00156 const FishSoundComment *
    00157 fish_sound_comment_next_byname (FishSound * fsound,
    00158                                 const FishSoundComment * comment);
    00159
    00168 int
    00169 fish_sound_comment_add (FishSound * fsound, FishSoundComment * comment);
    00170
    00180 int
    00181 fish_sound_comment_add_byname (FishSound * fsound, const char * name,
    00182                                const char * value);
    00183
    00193 int
    00194 fish_sound_comment_remove (FishSound * fsound, FishSoundComment * comment);
    00195
    00204 int
    00205 fish_sound_comment_remove_byname (FishSound * fsound, char * name);
    00206
    00207 #ifdef __cplusplus
    00208 }
    00209 #endif
    00210
    00211 #endif /* __FISH_SOUND_COMMENTS_H__ */