JVCL Help:TJvID3Frames.CheckFrames

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

Search in JVCL Help

 
Search in all projects
 

Summary

Indicates whether the value(s) of all frames are valid, and whether each frame is unique in the tag.


Pascal

 functionCheckFrames(constHandleError: TJvID3HandleError): Boolean;


Parameters

Parameters Description
const HandleError: TJvID3HandleError Specifies how to handle errors.


Return Value

The return value of CheckFrame depends on the value of HandleError:

HandleError Return value
heAutoCorrect Always returns true.
heRaise Raises an error when a frame is invalid, otherwise returns true.
heBoolean Returns false when a frame is invalid, otherwise returns true.


Description

CheckFrame is used by a tag controller, to check whether the value(s) of the frames in the tag are valid.
CheckFrame check for each frame in the tag, whether its values are correct. For example specifying an invalid language such as 'AAA' for the language property of a picture frame is incorrect. CheckFrame also checks whether all frames are unique in the tag. See CheckIsUnique for more info.
When HandleError is set to heAutoCorrect, then CheckFrame will auto correct invalid frames, duplicate frames will then be removed of the tag.
When you call Commit the tag controller always checks the value(s) of all frames are valid, and whether all frames in the tag are unique.


See Also

TJvID3Base.ChangeToVersion


About

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