IMcImageSetFilesSaveDataToInfoFile Method
|
|
Method used to save set data to an info file.
Namespace:
MediaCy.IQL.Sets.IO
Assembly:
MediaCy.IQL.Sets.IO (in MediaCy.IQL.Sets.IO.dll) Version: 10.0.6912.0
SyntaxFunction SaveDataToInfoFile (
SetOrSets As Object,
OriginalFileName As String
) As Boolean
Parameters
- SetOrSets
- Type: SystemObject
The image set or sets collection from which data should be saved (see Remarks) - OriginalFileName
- Type: SystemString
The full path to the set file (see Remarks)
Return Value
Type:
BooleanHRESULT with status, throws exceptions if fails.
RemarksThis method may be used by the application to save a side-by-side info file.
The OriginalFileName must be the full path name to the original set file - the side-by-side
info file will be written with the same name as the set but with the info file format extension added.
The info file format is assumed to be capable of saving all aspects of the provided set, even if
the original file format cannot.
SetOrSets should specify the image set or sets collection that was originally loaded from or saved
to the OriginalFilename file. Only a few set file formats support multiple image sets within one file.
The SaveDataToInfoFile format can also be used to document the sets within an arbitrary collection of
sets. In that case, OriginalFileName can be an application- or user-determined file name for the
info file. The resulting file should NOT be used with AddDataFromInfoFile.
See Also