Click or drag to resize

IMcStreamGetCompressionTypes Method

This method queries the Registry entries of McStream format indicated by "format", in the access mode indicated by "Mode", and fills the "descriptions" VARIANT with a safe-array of BSTR's with compression names, and a corresponding safe array stored in the VARIANT "ids" with the mccsCompression numbers in the same order as descriptions. The VARIANT image argument is either the image to query, an image type, or an image QuickType. This is to ensure that the compression schemes available support the data type of the image you wish to save.

Namespace:  MediaCy.IQL.IO
Assembly:  MediaCy.IQL.IO (in MediaCy.IQL.IO.dll) Version: 10.0.6912.0
Syntax
VB
Function GetCompressionTypes ( 
	Format As String,
	Mode As mcfmFileMode,
	image As Object,
	<OutAttribute> ByRef descriptions As Object,
	<OutAttribute> ByRef ids As Object
) As Integer

Parameters

Format
Type: SystemString
Mode
Type: MediaCy.IQL.IOmcfmFileMode
image
Type: SystemObject
descriptions
Type: SystemObject
ids
Type: SystemObject

Return Value

Type: Int32
LONG indicating the number of items in the descriptions and ids array
Remarks
This is primarily used by a File Options dialog to display a list of possible compression types the selected format supports.
Examples
VB
Dim descriptions as String
Dim ids as Long
Dim num as Long
num = ThisApplication.Images.File.GetCompressionTypes("tif", mcSTREAM_WRITE, McImageRGB, descriptions, ids)
for each long i in num
do
Debug.Print "Compression " & ids(i) & " = " & descriptions(i)
next i
See Also