TagsReader.ID3V2_CommercialFrameReceivedAsGet method |
|
Remarks
Obtains the type of "Received as" field of the given commercial frame (COMR) of the ID3V2 tag.
For further details about methods related to tags reading refer to the TagsReader object.
For details about the reading of tags see the How to read TAG information in sound files tutorial.
Syntax
[Visual Basic] control.TagsReader.ID3V2_CommercialFrameReceivedAsGet ( nIndex as Integer, ByRef nReceivedAs as enumId3v2ReceivedAsType ) as enumErrorCodes |
[C++] short control.TagsReader.ID3V2_CommercialFrameReceivedAsGet ( short nIndex, short *nReceivedAs ); |
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 TagsReader.ID3V2_FrameCountGet method with the strFrameId parameter set to "COMR". |
||||||||||||||||||||||||||||||
nReceivedAs |
Reference that, on return from the method call, will contain the type of "Received as" field. Supported values are the following:
|
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred (see the LastError property for further error details) |
enumErrorCodes.NOERROR (0) |
The method call was successful. |