JVCL Help:TJvConversion.Open@string@TJvConversionKind

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

Search in JVCL Help

 
Search in all projects
 

Summary

Starts the conversion operation.


Pascal

 functionOpen(constAFileName: string; constAKind: TJvConversionKind): Boolean; virtual; overload;
functionOpen(Stream: TStream; constAKind: TJvConversionKind): Boolean; virtual; overload;
functionOpen(Stream: TStream; constAKind: TJvConversionKind): Boolean; override;


Parameters

Parameters Description
const AFileName: string The file to import or export.
const AKind: TJvConversionKind Indicates whether to import or export the file or stream.
Stream: TStream The stream to import or export.


Return Value

Returns true on success, false on failure. If a converter returns false, the conversion operation is aborted.


Description

A TJvRichEdit control calls Open to start a conversion operation, either import or export as specified by the AKind parameter. This gives the converter a chance to open the source file or create the destination file, for example.
Following a successful call to Open will be multiple calls to either ConvertRead or ConvertWrite.


See Also

TJvConversion.Done, TJvConversion.Init


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