<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>include/id3/misc_support.h Source File</title> <link href="id3lib.css" rel="stylesheet" type="text/css"> </head><body bgcolor="#ffffff"> <!-- Generated by Doxygen 1.2.12 --> <center> <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> <hr><h1>include/id3/misc_support.h</h1><a href="misc__support_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <font class="comment">// -*- C++ -*-</font> 00002 <font class="comment">// $Id: misc_support.h,v 1.25 2001/07/30 18:22:53 abscess Exp $</font> 00003 00004 <font class="comment">// id3lib: a C++ library for creating and manipulating id3v1/v2 tags</font> 00005 <font class="comment">// Copyright 1999, 2000 Scott Thomas Haug</font> 00006 00007 <font class="comment">// This library is free software; you can redistribute it and/or modify it</font> 00008 <font class="comment">// under the terms of the GNU Library General Public License as published by</font> 00009 <font class="comment">// the Free Software Foundation; either version 2 of the License, or (at your</font> 00010 <font class="comment">// option) any later version.</font> 00011 <font class="comment">//</font> 00012 <font class="comment">// This library is distributed in the hope that it will be useful, but WITHOUT</font> 00013 <font class="comment">// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</font> 00014 <font class="comment">// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public</font> 00015 <font class="comment">// License for more details.</font> 00016 <font class="comment">//</font> 00017 <font class="comment">// You should have received a copy of the GNU Library General Public License</font> 00018 <font class="comment">// along with this library; if not, write to the Free Software Foundation,</font> 00019 <font class="comment">// Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</font> 00020 00021 <font class="comment">// The id3lib authors encourage improvements and optimisations to be sent to</font> 00022 <font class="comment">// the id3lib coordinator. Please see the README file for details on where to</font> 00023 <font class="comment">// send such submissions. See the AUTHORS file for a list of people who have</font> 00024 <font class="comment">// contributed to id3lib. See the ChangeLog file for a list of changes to</font> 00025 <font class="comment">// id3lib. These files are distributed with id3lib at</font> 00026 <font class="comment">// http://download.sourceforge.net/id3lib/</font> 00027 00028 <font class="preprocessor">#ifndef _ID3LIB_MISC_SUPPORT_H_</font> 00029 <font class="preprocessor"></font><font class="preprocessor">#define _ID3LIB_MISC_SUPPORT_H_</font> 00030 <font class="preprocessor"></font> 00031 <font class="preprocessor">#include <<a class="code" href="tag_8h.html">id3/tag.h</a>></font> 00032 00033 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <font class="keywordtype">char</font>* <a class="code" href="misc__support_8h.html#a1">ID3_GetString</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a> *, <a class="code" href="globals_8h.html#a218">ID3_FieldID</a>); 00034 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <font class="keywordtype">char</font>* <a class="code" href="misc__support_8h.html#a1">ID3_GetString</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a> *, <a class="code" href="globals_8h.html#a218">ID3_FieldID</a>, size_t nItems); 00035 00036 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <font class="keywordtype">void</font> <a class="code" href="misc__support_8h.html#a2">ID3_FreeString</a>(<font class="keywordtype">char</font> *str); 00037 00038 <font class="comment">// defined in 'id3_misc_support.cpp'</font> 00039 <font class="comment">// these are 'convenience functions,' to make using the library easier for the </font> 00040 <font class="comment">// most common of operations</font> 00041 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <font class="keywordtype">char</font>* <a class="code" href="misc__support_8h.html#a3">ID3_GetArtist</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); 00042 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a4">ID3_AddArtist</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <font class="keyword">const</font> <font class="keywordtype">char</font>*, <font class="keywordtype">bool</font> replace = <font class="keyword">false</font>); 00043 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> size_t <a class="code" href="misc__support_8h.html#a5">ID3_RemoveArtists</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); 00044 00045 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <font class="keywordtype">char</font>* <a class="code" href="misc__support_8h.html#a6">ID3_GetAlbum</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); 00046 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a7">ID3_AddAlbum</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <font class="keyword">const</font> <font class="keywordtype">char</font>*, <font class="keywordtype">bool</font> replace = <font class="keyword">false</font>); 00047 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> size_t <a class="code" href="misc__support_8h.html#a8">ID3_RemoveAlbums</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); 00048 00049 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <font class="keywordtype">char</font>* <a class="code" href="misc__support_8h.html#a9">ID3_GetTitle</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); 00050 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a10">ID3_AddTitle</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <font class="keyword">const</font> <font class="keywordtype">char</font>*, <font class="keywordtype">bool</font> replace = <font class="keyword">false</font>); 00051 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> size_t <a class="code" href="misc__support_8h.html#a11">ID3_RemoveTitles</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); 00052 00053 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <font class="keywordtype">char</font>* <a class="code" href="misc__support_8h.html#a12">ID3_GetYear</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); 00054 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a13">ID3_AddYear</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <font class="keyword">const</font> <font class="keywordtype">char</font>*, <font class="keywordtype">bool</font> replace = <font class="keyword">false</font>); 00055 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> size_t <a class="code" href="misc__support_8h.html#a14">ID3_RemoveYears</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); 00056 00057 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <font class="keywordtype">char</font>* <a class="code" href="misc__support_8h.html#a15">ID3_GetComment</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <font class="keyword">const</font> <font class="keywordtype">char</font>* desc = <a class="code" href="globals_8h.html#a24">NULL</a>); 00058 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a18">ID3_AddComment</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <font class="keyword">const</font> <font class="keywordtype">char</font>*, <font class="keywordtype">bool</font> = <font class="keyword">false</font>); 00059 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a18">ID3_AddComment</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <font class="keyword">const</font> <font class="keywordtype">char</font>*, <font class="keyword">const</font> <font class="keywordtype">char</font>*, <font class="keywordtype">bool</font> = <font class="keyword">false</font>); <a name="l00060"></a><a class="code" href="misc__support_8h.html#a1">00060</a> <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a18">ID3_AddComment</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <font class="keyword">const</font> <font class="keywordtype">char</font>*, <font class="keyword">const</font> <font class="keywordtype">char</font>*, <font class="keyword">const</font> <font class="keywordtype">char</font>*, 00061 <font class="keywordtype">bool</font> = <font class="keyword">false</font>); 00062 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> size_t <a class="code" href="misc__support_8h.html#a19">ID3_RemoveComments</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <font class="keyword">const</font> <font class="keywordtype">char</font> * = <a class="code" href="globals_8h.html#a24">NULL</a>); 00063 00064 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <font class="keywordtype">char</font>* <a class="code" href="misc__support_8h.html#a20">ID3_GetTrack</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); 00065 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> size_t <a class="code" href="misc__support_8h.html#a21">ID3_GetTrackNum</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); 00066 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a23">ID3_AddTrack</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <a class="code" href="globals_8h.html#a33">uchar</a> ucTrack, <a class="code" href="globals_8h.html#a33">uchar</a> ucTotal = 0, 00067 <font class="keywordtype">bool</font> replace = <font class="keyword">false</font>); 00068 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a23">ID3_AddTrack</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <a class="code" href="globals_8h.html#a33">uchar</a> ucTrack, <font class="keywordtype">bool</font> replace); 00069 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> size_t <a class="code" href="misc__support_8h.html#a23">ID3_RemoveTracks</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); 00070 00071 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <font class="keywordtype">char</font>* <a class="code" href="misc__support_8h.html#a24">ID3_GetGenre</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); <a name="l00072"></a><a class="code" href="misc__support_8h.html#a2">00072</a> <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> size_t <a class="code" href="misc__support_8h.html#a25">ID3_GetGenreNum</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); 00073 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a26">ID3_AddGenre</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, size_t ucGenre, <font class="keywordtype">bool</font> replace = <font class="keyword">false</font>); 00074 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> size_t <a class="code" href="misc__support_8h.html#a27">ID3_RemoveGenres</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); 00075 00076 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <font class="keywordtype">char</font>* <a class="code" href="misc__support_8h.html#a28">ID3_GetLyrics</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); 00077 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a31">ID3_AddLyrics</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <font class="keyword">const</font> <font class="keywordtype">char</font>*, <font class="keywordtype">bool</font> = <font class="keyword">false</font>); <a name="l00078"></a><a class="code" href="misc__support_8h.html#a3">00078</a> <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a31">ID3_AddLyrics</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <font class="keyword">const</font> <font class="keywordtype">char</font>*, <font class="keyword">const</font> <font class="keywordtype">char</font>*, <font class="keywordtype">bool</font> = <font class="keyword">false</font>); 00079 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a31">ID3_AddLyrics</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <font class="keyword">const</font> <font class="keywordtype">char</font>*, <font class="keyword">const</font> <font class="keywordtype">char</font>*, <font class="keyword">const</font> <font class="keywordtype">char</font>*, 00080 <font class="keywordtype">bool</font> = <font class="keyword">false</font>); 00081 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> size_t <a class="code" href="misc__support_8h.html#a32">ID3_RemoveLyrics</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); 00082 00083 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <font class="keywordtype">char</font>* <a class="code" href="misc__support_8h.html#a33">ID3_GetLyricist</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); 00084 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a34">ID3_AddLyricist</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a> *, <font class="keyword">const</font> <font class="keywordtype">char</font> *, <font class="keywordtype">bool</font> replace = <font class="keyword">false</font>); 00085 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> size_t <a class="code" href="misc__support_8h.html#a35">ID3_RemoveLyricist</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*); 00086 00087 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a39">ID3_AddSyncLyrics</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <font class="keyword">const</font> <a class="code" href="globals_8h.html#a33">uchar</a>*, size_t, 00088 <a class="code" href="globals_8h.html#a225">ID3_TimeStampFormat</a>, <font class="keywordtype">bool</font> = <font class="keyword">false</font>); 00089 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a39">ID3_AddSyncLyrics</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <font class="keyword">const</font> <a class="code" href="globals_8h.html#a33">uchar</a>*, size_t, 00090 <a class="code" href="globals_8h.html#a225">ID3_TimeStampFormat</a>, <font class="keyword">const</font> <font class="keywordtype">char</font> *, <font class="keywordtype">bool</font> = <font class="keyword">false</font>); 00091 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a39">ID3_AddSyncLyrics</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <font class="keyword">const</font> <a class="code" href="globals_8h.html#a33">uchar</a>*, size_t, 00092 <a class="code" href="globals_8h.html#a225">ID3_TimeStampFormat</a>, <font class="keyword">const</font> <font class="keywordtype">char</font> *, <font class="keyword">const</font> <font class="keywordtype">char</font> *, 00093 <font class="keywordtype">bool</font> = <font class="keyword">false</font>); 00094 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a39">ID3_AddSyncLyrics</a>(<a class="code" href="class_i_d3___tag.html">ID3_Tag</a>*, <font class="keyword">const</font> <a class="code" href="globals_8h.html#a33">uchar</a>*, size_t, 00095 <a class="code" href="globals_8h.html#a225">ID3_TimeStampFormat</a>, <font class="keyword">const</font> <font class="keywordtype">char</font> *, <font class="keyword">const</font> <font class="keywordtype">char</font> *, 00096 <a class="code" href="globals_8h.html#a224">ID3_ContentType</a>, <font class="keywordtype">bool</font> = <font class="keyword">false</font>); <a name="l00097"></a><a class="code" href="misc__support_8h.html#a4">00097</a> <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a41">ID3_GetSyncLyricsInfo</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___tag.html">ID3_Tag</a> *tag, <font class="keyword">const</font> <font class="keywordtype">char</font> *lang, 00098 <font class="keyword">const</font> <font class="keywordtype">char</font> *desc, <font class="keywordtype">char</font> &stampformat, 00099 <font class="keywordtype">char</font> &type, size_t &size); 00100 <a class="code" href="globals_8h.html#a0">ID3_C_EXPORT</a> <a class="code" href="class_i_d3___frame.html">ID3_Frame</a>* <a class="code" href="misc__support_8h.html#a42">ID3_GetSyncLyrics</a>(<font class="keyword">const</font> <a class="code" href="class_i_d3___tag.html">ID3_Tag</a> *tag, <font class="keyword">const</font> <font class="keywordtype">char</font> *lang, 00101 <font class="keyword">const</font> <font class="keywordtype">char</font> *desc, <font class="keywordtype">char</font> *pData, size_t &size); 00102 00103 <font class="preprocessor">#endif </font><font class="comment">/* _ID3LIB_MISC_SUPPORT_H_ */</font> </pre></div><hr><address><small>Generated on Thu Jan 3 07:35:55 2002 for id3lib by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.gif" alt="doxygen" align="middle" border=0 width=110 height=53></a>1.2.12 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2001</small></address> </body> </html>