mfccddb.htm

MfcCDDB v1.11 A freeware MFC class to support access to CDDB servers Welcome to MfcCDDB, a collectio

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_sDescription"></a><big><strong>CCDDBSite::m_sDescription</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_sDescription is of type CString and contains a simple description
of the CDDB site e.g. &quot;Random US Site&quot;.</font></p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p><a name="CCDDBQueryResult"></a><big><font face="Arial"><strong>CCDDBQueryResult::CCDDBQueryResult</strong></font></big></p>

<p><font face="Arial"><strong>CCDDBQueryResult();</strong></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">Standard constructor for the class. This class represents the
information for a single site as returned from the <a href="#Query"><strong>CDDB::Query</strong></a>
function.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="CCDDBQueryResult_operator="></a><big><strong>CCDDBQueryResult::operator=</strong></big></font></p>

<p><font face="Arial"><strong>CCDDBQueryResult&amp; operator=(const CCDDBQueryResult&amp;</strong><em>
result</em><strong>);</strong></font></p>

<p><font face="Arial"><strong>Parameters</strong></font></p>

<p><font face="Arial"><em>result</em> This CCDDBQueryResult instance to copy into this
instance.</font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">Standard operator= for the CCDDBQueryResult class.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_sCategory"></a><big><strong>CCDDBQueryResult::m_sCategory</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_sCategory is of type CString and contains the category of the
album.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="result_m_dwDiscID"></a><big><strong>CCDDBQueryResult::m_dwDiscID</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_dwDiscID is of type DWORD and contains the CDDB DISC-ID of the
album.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="result_m_sArtist"></a><big><strong>CCDDBQueryResult::m_sArtist</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_sArtist is of type CString and contains the Artist of the album.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="result_m_sTitle"></a><big><strong>CCDDBQueryResult::m_sTitle</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_sTitle is of type CString and contains the title of the album.</font></p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p><font face="Arial"><strong><big><a name="CCDDBRecord"></a>CCDDBRecord</big></strong></font></p>

<p><font face="Arial">This class represents the information for a single album as returned
from the <a href="#Read"><strong>CDDB::Read</strong></a> function.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_TrackOffsets"></a><strong><big>CCDDBRecord::m_TrackOffsets</big></strong></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_TrackOffsets is of type CArray&lt;int, int&amp;&gt; and contains
the offset of each track (including the leadout track) in frames.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_nDiskLength"></a><strong><big>CCDDBRecord::m_nDiskLength</big></strong></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_nDiskLength is of type int and contains the number of seconds of
the CD's play length.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_nDatabaseRevision"></a><strong><big>CCDDBRecord::m_nDatabaseRevision</big></strong></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_nDatabaseRevision is of type int and contains the revision number
of this album in the database. This is used internally by CDDB for database management.
When you are allowing the user to modify a database entry, you should increment this
number prior to submitting the modified entry to CDDB.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_sClientName"></a><strong><big>CCDDBRecord::m_sClientName</big></strong></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_sClientName is of type CString and contains the name of the client
application which submitted this record to CDDB.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_sClientVersion"></a><strong><big>CCDDBRecord::m_sClientVersion</big></strong></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_sClientVersion is of type CString and contains the version number
of the client application which submitted this record to CDDB. Please see the CDDB howto
document for the format which should be used.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_sClientComments"></a><strong><big>CCDDBRecord::m_sClientComments</big></strong></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_sClientComments is of type CString and contains optional comments
which you want to include along with the ClientName and Client Version.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="record_m_dwDiscID"></a><big><strong>CCDDBRecord::m_dwDiscID</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_dwDiscID is of type DWORD and contains the CDDB DISC-ID of the
album.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="record_m_sArtist"></a><big><strong>CCDDBRecord::m_sArtist</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_sArtist is of type CString and contains the Artist of the album.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="record_m_sTitle"></a><big><strong>CCDDBRecord::m_sTitle</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_sTitle is of type CString and contains the title of the album.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_TrackTitles"></a><strong><big>CCDDBRecord::m_TrackTitles</big></strong></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_TrackTitles is of type CStringArray and contains the title of each
track of the album.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_ExtendedData"></a><strong><big>CCDDBRecord::m_ExtendedData</big></strong></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_ExtendedData is of type CStringArray and contains the names of any
extended data associated with this album. For example it could contain
&quot;Producer:Jimmy Page&quot;, &quot;Executive Producer: Peter Grant&quot; and
&quot;Year: 1976&quot;.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_ExtendedTrackData"></a><strong><big>CCDDBRecord::m_ExtendedTrackData</big></strong></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_ExtendedTrackData is of type CStringArray and contains the
extended data for each track on the album. For example this could contain the vocalists
for each track. The array will come back with as many elements in the array as tracks on
the album. If no data is present for any track then the string for that title will be a
empty string.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_PlayOrder"></a><strong><big>CCDDBRecord::m_PlayOrder</big></strong></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_PlayOrder is of type CArray&lt;int, int&gt; and contains the
customized play order for this album. Generally this is stripped when submitted to a
non-local CDDB database. You might want to allow your application to store this locally as
a user preference. You should also ensure that this information is stripped prior to
submitting this record to a CDDB server.</font></p>

<p>&nbsp;</p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="CCDDBStatus"></a><strong><big>CCDDBStatus</big></strong></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">This class represents the information as returned from the <a
href="#Status"><strong>CDDB::Status</strong></a> function.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_nCurrentProtocol"></a><strong><big>CCDDBStatus::m_nCurrentProtocol</big></strong></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_nCurrentProtocol is of type int and contains the server's current
operating protocol level.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_nMaxProtocol"></a><strong><big>CCDDBStatus::m_nMaxProtocol</big></strong></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_nMaxProtocol is of type int and contains the server's maximum
supported operating protocol level.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_bGetsAllowed"></a><big><strong>CCDDBStatus::m_bGetsAllowed</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_bGetsAllowed is of type BOOL and is TRUE if the client is allowed
to get log information otherwise FALSE.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_bUpdatesAllowed"></a><big><strong>CCDDBStatus::m_bUpdatesAllowed</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_bUpdatesAllowed is of type BOOL and is TRUE if the client is
allowed to initiate a database update otherwise FALSE.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_bPostingAllowed"></a><big><strong>CCDDBStatus::m_bPostingAllowed</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_bPostingAllowed is of type BOOL and is TRUE if the client is
allowed to post new entries to the database otherwise FALSE.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_bQuotes"></a><big><strong>CCDDBStatus::m_bQuotes</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_bQuotes is of type BOOL and is TRUE if quoted arguments are
enabled otherwise FALSE.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_nCurrentUsers"></a><big><strong>CCDDBStatus::m_nCurrentUsers</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_nCurrentUsers is of type int and is the number of users currently
connected to the server.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_nMaxUsers"></a><big><strong>CCDDBStatus::m_nMaxUsers</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_nMaxUsers is of type int and is the maximum number of users that
can connect to the server concurrently.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_bStripExtended"></a><big><strong>CCDDBStatus::m_bStripExtended</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_bStripExtended is of type BOOL and is TRUE if extended data is
stripped by the server before being presented to the user otherwise FALSE.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_nDatabaseEntries"></a><big><strong>CCDDBStatus::m_nDatabaseEntries</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_nDatabaseEntries is of type int and is the total number of entries
in the database.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_Categories"></a><big><strong>CCDDBStatus::m_Categories</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_Categories is of type CStringArray and is the list of all the
categories in the database.</font></p>

<p>&nbsp;</p>

<p><font face="Arial"><a name="m_CategoryEntries"></a><big><strong>CCDDBStatus::m_CategoryEntries</strong></big></font></p>

<p><font face="Arial"><strong>Remarks</strong></font></p>

<p><font face="Arial">m_CategoryEntries is of type CArray&lt;int, int&gt; and contains the
number of entries for each category in the database. The elements at each offset