Click or drag to resize

IMcFilesStore Method

This method stores an McImage to a file. If the OutputPrefix property is set, that string is used as the base for the file name. Then the method will determine the next OutputNumber to append to the OutputPrefix, and finally the extension of the format indicated by OutputStream. If the Overwrite flag is not set, the method will increment OutputNumber until a unique filename is found. If the Overwrite flag is set, the image is written despite any existing files with the same name. After writing, the OutputNumber is incremented by one. If the OutputPrefix is not set, the FileName of the OutputStream is used as the FileName. The String of the FileName used to store the image is returned in either case.

Namespace:  MediaCy.IQL.IO
Assembly:  MediaCy.IQL.IO (in MediaCy.IQL.IO.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Function Store ( 
	pImage As McImage,
	Optional FileName As String = ""
) As String

Parameters

pImage
Type: MediaCy.IQL.EngineMcImage
The McImage you wish to store
FileName (Optional)
Type: SystemString
an optional argument that is the name of the file you wish to store the image as. If this is not supplied, the OutputPrefix and OutputNumbers are used. If these are not supplied, the McStream.FileName is used. If this is not supplied, an error returns.

Return Value

Type: String
String StoredName - The filename used to store the McImage.
Remarks
Used primarily by Screen Capture
Examples
VB
Copy
' write the image as a JPEG file named first.jpg
ImageFiles.OutputStream.Format = "jpg"
ImageFiles.Store (ActiveImage, "c:\temp\first.jpg")
' write the image as a TIFF file using a Prefix and Numbers
ImageFiles.OutputStream.Format = "tif"
ImageFiles.OutputPrefix = "Capture"
ImageFiles.OutputNumbers = 100
' the next line writes the file Capture100.tif
ImageFiles.Store ActiveImage
' the next line writes the file Capture101.tif
ImageFiles.Store ActiveImage
See Also