Copyright © 2008-2018 MultiMedia Soft

TagsEditor.ID3V2_CommentFrameRemove method

Previous pageReturn to chapter overviewNext page

Remarks

 

Removes a comment frame (COMM) from the ID3V2 tag.

The modification only happens in memory and not directly into the original sound file: in order to store modifications inside the file you need to call the TagsEditor.ID3V2_SaveChanges method.

 

For further details about methods related to tags editing refer to the TagsEditor object.

For details about the editing of tags see the How to edit tag info in sound files tutorial.

 

 

Syntax

 

[Visual Basic]

control.TagsEditor.ID3V2_CommentFrameRemove (

nIndex as Integer

) as enumErrorCodes


 

[C++]

short control.TagsEditor.ID3V2_CommentFrameRemove (

short nIndex

);


 

Parameter

Description

 

 

nIndex

Zero-based index of the comment frame. The total number of comment frames available inside the ID3V2 tag can be obtained through a call to the TagsEditor.ID3V2_FrameCountGet method with the strFrameId parameter set to "COMM".

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.