Copyright © 2011-2018 MultiMedia Soft

TagsEditor.ID3V2_CommercialFrameInfoGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains textual information about the given ID3V2 commercial frame (COMR).

 

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

nIndex as Int32,

nInfo as enumId3v2CommercialInfo

) as String


 

[C#]

public string ID3V2_CommercialFrameInfoGet (

Int32 nIndex,

enumId3v2CommercialInfo nInfo

);


 

[C++]

public: string ID3V2_CommercialFrameInfoGet (

Int32 nIndex,

enumId3v2CommercialInfo nInfo

);


 

Parameter

Description

 

 

nIndex

Zero-based index of the commercial frame. The total number of commercial frames available inside the ID3V2 tag can be obtained through a call to the TagsEditor.ID3V2_FrameCountGet method with the strFrameId parameter set to "COMR".

nInfo

Type of information that needs to be retrieved.

Supported values are the following:

Mnemonic Value

Value

Meaning

ID3V2_COMMERCIAL_INFO_PRICE

0

Price

ID3V2_COMMERCIAL_INFO_VALID_UNTIL

1

Valid until

ID3V2_COMMERCIAL_INFO_CONTACT_URL

2

Contact URL

ID3V2_COMMERCIAL_INFO_SELLER

3

Seller

ID3V2_COMMERCIAL_INFO_DESCRIPTION

4

Description

ID3V2_COMMERCIAL_INFO_PICTURE_MIME_TYPE

5

Picture mime type

ID3V2_COMMERCIAL_INFO_RECEIVED_AS_TEXT

6

Received As text

 

 

Return value

 

Value

Meaning

 

 

Empty string

The information is not available or an error occurred (see the LastError property for further error details)

Valid string

String with the requested information