Copyright © 2011-2018 MultiMedia Soft

TagsEditor.ID3V2_TextFrameSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets contents of a specific text-based frame of the ID3V2 tag. Current contents can be retrieved through the TagsEditor.ID3V2_TextFrameGet method.

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_TextFrameSet (

strFrameId as string,

strText as string

) as enumErrorCodes


 

[C#]

public enumErrorCodes ID3V2_TextFrameSet (

string strFrameId,

string strText

);


 

[C++]

public: enumErrorCodes ID3V2_TextFrameSet (

string strFrameId,

string strText

);


 

Parameter

Description

 

 

strFrameId

String containing the identifier of the specific frame to set.

Supported identifiers for text-based frames are the following: TIT1, TIT2, TIT3, TALB, TOAL, TRCK, TPOS, TSST, TSRC, TPE1, TPE2, TPE3, TPE4, TOPE, TEXT, TOLY, TCOM, TMCL, TIPL, TENC, TBPM, TLEN, TKEY, TLAN, TCON, TFLT, TMED, TMOO, TCOP, TPRO, TPUB, TOWN, TRSN, TRSO, TOFN, TDLY, TDEN, TDOR, TDRC, TDRL, TDTG, TSSE, TSOA, TSOP, TSOT.

strText

String of text to enter inside the given frame.

Passing an empty string causes the removal of the frame from the tag.

 

 

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.