JVCL Help:TJvID3Frames.FindFrame@AnsiString

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

 functionFindFrame(constFrameName: AnsiString): TJvID3Frame; overload;
functionFindFrame(constFrameID: TJvID3FrameID): TJvID3Frame; overload;


Parameters

Parameters Description
const FrameName: AnsiString The frame name of the frame for which to search.
const FrameID: TJvID3FrameID The frame identifier of the frame for which to search.


Return Value

If FindFrame finds a frame with a matching name, it returns the TJvID3Frame component for the specified frame. Otherwise it returns nil.


Description

Call FindFrame to determine if a specified frame component is referenced in the TJvID3Frames object.
The tag controller uses the TJvID3FrameID type to identify frames. In the tag itself the frames are identified by a 4 character long name. FrameID identifies the frame by the TJvID3FrameID type and FrameName identifies the frame by the 4 characters.


See Also

TJvID3Frame.FrameName, TJvID3Frames.FrameByID, TJvID3Frames.FrameByName


About

Notes

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


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