Description

McFiles Class

Object Model


Members

Methods
Convert

Converts a file from one file type to another, with options. Similiar to McImageLib.McImage.Convert, but with files.

Properties: String Source - The directory or filename, with or without tokens, you wish to convert.

SaveSettings

This method allows a client to persist the settings of an individual Stream type, for an indivdual context. For example, one could use this method to save the settings of the last ScreenCapture, and these values would be available the next time ScreenCapture is run as the default values. These values would not, however, be the default settings for Convert or for File Open or Save.

The pStream parameter is optional, and will override the ImageFiles own member stream.

Properties: LPUNKNOWN ContextPropertyBag - The IPropertyBag object in which to save the Settings McStream* pStream - [optional] the settings to save, or if NULL, then save the settings of the current McStream.

Store

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.


Properties
FileSignatureRead-only property

Returns the computed unique File Signature for the File pointed to in Path. Path can be either a String, or an McStream reference.

FlagsRead-write property

Gets or Sets the the Flags used for Screen Capture or Conversion.

OutputImageTypeRead-write property

Sets the ImageType for the output files of Convert or Store

OutputNumbersRead-write property

Gets or Sets the the Suffix numbers used for identifying Screen Captures. After each successive screen capture, the OutputNumbers are incremented. If a file currently exists with the same name, the OutputNumbers are incremented until a unique filename is found.

OutputPathRead-write property

Gets or Sets the Full Pathname of where converted or stored images should be placed.

OutputPrefixRead-write property

Gets or Sets the the Prefix string used for identifying Screen Grabs. If no prefix is indicated, the OutputStream's FileName is used.

OutputStreamRead-write property

Gets or Sets the the McStream used for writing the output. On initial Get, the stream is created.

RecursiveRead-write property

Gets or Sets the the Boolean value indicating whether a call to Convert searches sub-directories to find all image files that match. Defaults to False.

SaveFramesIndividuallyRead-write property

If a sequence (multiple frame image) is used as the Source for Convert, but a single image format (such as JPG or PNG) is used as the OutputFormat, the user has the option to save the individual frames as successive images, or to only save the first frame of the sequence.