|
TagsEditor.ID3V2_UserTextFrameRemove method |
  
|
|
TagsEditor.ID3V2_UserTextFrameRemove method |
|
Remarks
Removes the given user defined text frame (TXXX) 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 TagsEditorMan class.
For details about the editing of tags see the How to edit tag info in sound files tutorial.
Syntax
[Visual Basic] Public Function ID3V2_UserTextFrameRemove ( nIndex as Int32 ) as enumErrorCodes |
[C#] public enumErrorCodes ID3V2_UserTextFrameRemove ( Int32 nIndex ); |
[C++] public: enumErrorCodes ID3V2_UserTextFrameRemove ( Int32 nIndex ); |
Parameter |
Description |
|
|
nIndex |
Zero-based index of the user defined text frame. The total number of user defined text frames available inside the ID3V2 tag can be obtained through a call to the TagsEditor.ID3V2_FrameCountGet method with the strFrameId parameter set to "TXXX". |
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. |
