|
TagsEditor.OGG_UserFrameSet method |
  
|
|
TagsEditor.OGG_UserFrameSet method |
|
Remarks
Sets contents of a specific user-defined frame of the OGG Vorbis tag. Current contents can be retrieved through the TagsEditor.OGG_UserFrameGet 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_UserFrameSet ( strFrameId as string, strText as string ) as enumErrorCodes |
[C#] public enumErrorCodes OGG_UserFrameSet ( string strFrameId, string strText ); |
[C++] public: enumErrorCodes OGG_UserFrameSet ( string strFrameId, string strText ); |
Parameter |
Description |
|
|
strFrameId |
String containing the identifier of the specific user-defined frame to set. You can know which frames are available inside the OGG Vorbis tag by using the combination of the TagsEditor.OGG_UniqueFramesCountGet and TagsEditor.OGG_UniqueFramesIdGet methods. If a frame with the same identifier is already available, its content is replaced. If there is no frame with the given identifier, a new one is added. |
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. |
