|
TagsEditor.OGG_TextFrameSet method |
  
|
|
TagsEditor.OGG_TextFrameSet method |
|
Remarks
Sets contents of a specific text-based frame of the OGG Vorbis tag. Current contents can be retrieved through the TagsEditor.OGG_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.OGG_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 OGG_TextFrameSet ( nFrameId as enumOggFrames, strText as String ) as enumErrorCodes |
[C#] public enumErrorCodes OGG_TextFrameSet ( enumOggFrames nFrameId, string strText ); |
[C++] public: enumErrorCodes OGG_TextFrameSet ( enumOggFrames nFrameId, string strText ); |
Parameter |
Description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
nFrameId |
Identifier of the tag frame to set. Supported values are the following:
User-defined frames can be added and retrieved through the TagsEditor.OGG_UserFrameSet and TagsEditor.OGG_UserFrameGet methods. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
strText |
String of text to enter inside the given frame |
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. |
