QueryFileV Method

Description

This method has been deprecated and will be removed from ImagXpress in a future release. Please use QueryFileV2 instead.

Obtains information about an image file.

Syntax

Visual Basic
Public Sub QueryFileV( _ ByVal FileName As String, _ ByVal PageNbr As Long, _ ByRef width As Variant, _ ByRef height As Variant, _ ByRef BPP As Variant, _ ByRef Format As Variant, _ ByRef FileSize As Variant, _ ByRef ResUnits As Variant, _ ByRef ResX As Variant, _ ByRef ResY As Variant _ )

Visual Basic

Public Sub QueryFileV( _
   ByVal FileName As String, _
   ByVal PageNbr As Long, _
   ByRef width As Variant, _
   ByRef height As Variant, _
   ByRef BPP As Variant, _
   ByRef Format As Variant, _
   ByRef FileSize As Variant, _
   ByRef ResUnits As Variant, _
   ByRef ResX As Variant, _
   ByRef ResY As Variant _
)

Parameters

FileName: The file to be queried.
PageNbr: Page number within the file to query.
width: A variant value that evaluates to the image width in pixels.
height: A variant value that evaluates to the image height in pixels.
BPP: A variant value that evaluates to the image bits per pixel.
Format: A variant value that evaluates to the image format.
FileSize: A variant value that evaluates to the image file size.
ResUnits: A variant value that evaluates to the image resolution units.
ResX: A variant value that evaluates to the image X resolution.
ResY: A variant value that evaluates to the image Y resolution.

Remarks

QueryFileV obtains information about an image file but does not load the image. Information about the image is returned in the Width, Height, BPP, Format, FileSize, ResUnits, ResX, and ResY parameters.

FileName may be a remote or local file. It may not be an http or ftp address.

ResUnits, ResX, and ResY are returned for the following image formats: TIFF, JPEG, PDF, PIC, PNG, BMP, RLE, PCX. These values will be set to zero if the image does not contain resolution information.

If QueryFileV is successful, the ImagError Property is set to 0 (ErrorNone). If QueryFileV fails, the ImagError Property will be set to a non zero value.

The QueryFileV Method is identical to the QueryFile2 Method except that the return values for Width, Height, BPP, Format, FileSize, ResUnits, ResX, and ResY are VARIANTS. If you are using VB Script or if you are using Visual Basic and wish to use implicit variables, you must use the QueryFileV Method. If using C++, you can avoid the variant conversions by using the QueryFile Method.