TagsEditor.ID3V2_PictureFrameAddFromFile method |
|
Remarks
Adds to the ID3V2 tag a new picture frame (APIC) taken from the picture contained inside a graphical file. If a picture frame having the same description and picture type already exists, it will be replaced by the new one.
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_PictureFrameAddFromFile ( strPathname as String, strDescription as String, nPictureType as enumId3v2PictureType ) as enumErrorCodes |
[C#] public string ID3V2_PictureFrameAddFromFile ( string strPathname, string strDescription, enumId3v2PictureType nPictureType ); |
[C++] public: string ID3V2_PictureFrameAddFromFile ( string strPathname, string strDescription, enumId3v2PictureType nPictureType ); |
Parameter |
Description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
strPathname |
String representing the absolute pathname of the graphical file |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
strDescription |
String representing the picture description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nPictureType |
Value representing the type of picture. Supported values are the following:
|
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. |