Copyright © 2005-2018 MultiMedia Soft

TagsReader.ID3V2_UserTextFrameDescriptionGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the description of the text for the given ID3V2 user text frame (TXXX).

 

For further details about methods related to tags reading refer to the TagsReaderMan class.

For details about the reading of tags see the How to read TAG information in sound files tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function ID3V2_UserTextFrameDescriptionGet (

nIndex as Int32

) as String


 

[C#]

public string ID3V2_UserTextFrameDescriptionGet (

Int32 nIndex

);


 

[C++]

public: string ID3V2_UserTextFrameDescriptionGet (

Int32 nIndex

);


 

Parameter

Description

 

 

nIndex

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

 

 

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