Description
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.
-
Return Type
-
A String value.
String StoredName - The filename used to store the McImage.
-
Syntax
-
object.Store (pImage, [FileName])
The Store Method syntax has these parts: |
| object | An expression evaluating to an object of type McFiles. | | pImage | Required. A McImage object. The McImage you wish to store
| | FileName | Optional. A String value. 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.
|
Remarks
Used primarily by Screen Capture
|
Store Method
