JVCL Help:TJvID3Frames.FrameByName

From Project JEDI Wiki
Jump to navigationJump to search
JEDI Visual Component Library Help

Search in JVCL Help

 
Search in all projects
 

Summary

Returns a frame given its frame name.


Pascal

 functionFrameByName(constFrameName: AnsiString): TJvID3Frame;


Parameters

Parameters Description
const FrameName: AnsiString The frame name of an existing frame.


Return Value

FrameByName returns the TJvID3Frame component for the specified frame. If the frame can not be found, an exception is raised.


Description

Call FrameByName to retrieve frame information for a frame when only the frame’s name is known.
The tag controller uses the TJvID3FrameID type to identify frames. In the tag itself the frames are identified by a 4 character long name. Parameter FrameName identifies the frame by the 4 characters.


See Also

TJvID3Frames.FindFrame


About

Notes

FrameByName differs from the FindFrame method only when the named frame is not in the list. When the frame is not found, FrameByName raises an exception, while FindFrame returns nil.


Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page