Copyright © 2008-2015 MultiMedia Soft

TagsEditor.ALL_CommonFrameSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Modifies the contents of a tag field common to most of the tags format. The current content can be obtained through the TagsEditor.ALL_CommonFrameGet 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.ALL_SaveChanges method. It's important to note that both this method and the TagsEditor.ALL_SaveChanges method will have effect only in case a tag should already exist inside the sound file.

 

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

nField as enumTagFields,

strText as String

) as enumErrorCodes


 

[C#]

public enumErrorCodes ALL_CommonFrameSet (

enumTagFields nField,

string strText

);


 

[C++]

public: enumErrorCodes ALL_CommonFrameSet (

enumTagFields nField,

string strText

);


 

Parameter

Description

 

 

nField

Identifier of the tag field to set.

Supported values are the following:

Mnemonic Value

Value

Meaning

TAG_FIELD_TITLE

0

Title

TAG_FIELD_ARTIST

1

Artist

TAG_FIELD_ALBUM

2

Album

TAG_FIELD_YEAR

3

Year

TAG_FIELD_COMMENT

4

Comment

TAG_FIELD_TRACK

5

Track number

TAG_FIELD_GENRE_CODE

6

Genre code for ID3

TAG_FIELD_GENRE_STRING

7

Genre string

TAG_FIELD_COMPOSER

8

Composer

TAG_FIELD_COPYRIGHT

9

Copyright

TAG_FIELD_SUBTITLE

10

Subtitle

TAG_FIELD_ALBUMARTIST

11

Album artist

strText

String of text to enter inside the given field

 

 

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.