TagsEditor.ID3V2_UserTextFrameDescriptionGet method |
|
Remarks
Obtains the description of the text for the given ID3V2 user text frame (TXXX).
For further details about methods related to tags editing refer to the TagsEditor object.
For details about the editing of tags see the How to edit tag info in sound files tutorial.
Syntax
[Visual Basic] control.TagsEditor.ID3V2_UserTextFrameDescriptionGet ( nIndex as Integer ) as String |
[C++] BSTR control.TagsEditor.ID3V2_UserTextFrameDescriptionGet ( short 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 TagsEditor.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 |