diff options
author | Josh Coalson <jcoalson@users.sourceforce.net> | 2004-12-30 00:59:30 +0000 |
---|---|---|
committer | Josh Coalson <jcoalson@users.sourceforce.net> | 2004-12-30 00:59:30 +0000 |
commit | def597ee59e41e6ac9a170dead3e1f8300135689 (patch) | |
tree | e53902ac31b2222743b6be5b5042c6b9dcdbe9b7 /include/FLAC/format.h | |
parent | 8ddf7fb278d7a9cb2ec9a8c66a73768ef5956573 (diff) | |
download | flac-def597ee59e41e6ac9a170dead3e1f8300135689.tar.gz |
additions to metadata object api: more vorbiscomment functions, trailing-null on vorbis comment field values enforced everywhere
Diffstat (limited to 'include/FLAC/format.h')
-rw-r--r-- | include/FLAC/format.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/include/FLAC/format.h b/include/FLAC/format.h index e003c34f..d4e6bcac 100644 --- a/include/FLAC/format.h +++ b/include/FLAC/format.h @@ -583,6 +583,15 @@ typedef struct { /** Vorbis comment entry structure used in VORBIS_COMMENT blocks. (c.f. <A HREF="../format.html#metadata_block_vorbis_comment">format specification</A>) + * + * For convenience, the APIs maintain a trailing NUL character at the end of + * \a entry which is not counted toward \a length or stored in the stream, + * i.e. + * \code strlen(entry) == length \endcode + * + * It's recommended but not required for users to follow this convention as + * well when dealing directly with FLAC__StreamMetadata_VorbisComment_Entry + * as it makes dealing with plain strings easier. */ typedef struct { FLAC__uint32 length; |