GetPhysicalSize (ImageKit Control/ Scan Method)

This method retrieves the largest physical size that can be scanned with a given scan device.

[Visual Basic] [ Boolean = ]imagekitcontrolname.Scan.GetPhysicalSize(Width As Single, Height As Single)

[Visual C++] [ BOOL = ]imagekitcontrolname.GetScan().GetPhysicalSize(float *Width, float *Height)

[VB.NET] [ Boolean = ]imagekitcontrolname.Scan.GetPhysicalSize(ByRef Width As Single, ByRef Height As Single)

[C#.NET] [ bool = ]imagekitcontrolname.Scan.GetPhysicalSize(ref float Width, ref float Height)

Parameters

Name	Explanation
Width	The largest physical width of the scan
Height	The largest physical height of the scan

Return Value

Returns True (nonzero) when successful, returns False (0) when not successful.

Explanation

The GetPhysicalSize method retrieves the largest physical size that can be scanned with a given scan device.

When the UnitMode property is set to 5(ikScanPixel), please set XResolution and YResolution properties with the resolution (DPI) value. The physical size will be retrieved from these resolution values. If 0 is set into the XResolution and YResolution properties, the physical size retrieved will correspond to the current resolution.

To retrieve the largest physical size the DsName, ScanMode, and UnitMode properties must be set. If the DsName property is blank then prior to executing this method, please execute the Select method. (If the OpenDS method has been executed, the DsName is disabled and the open scan device will be used.) Set the ScanMode property from 0 to 2 or 7 and 8 and set the UnitMode to values supported by the datasource (scan device). The Width and Height parameters will return values depending on the ScanMode and UnitMode properties. When UnitMode is 5 (Pixels), the Width and Height parameters will depend on the current resolution (DPI).

To execute the GetPhysicalSize method you must first execute the Initialize method. If the OpenDS method is executed prior to executing the GetPhysicalSize method then the open datasource cannot be used by another application until that datasource (scan device) is closed.

For scripting languages and other programs that require variant types, please refer to the GetPhysicalSizeVariant method.

The GetPhysicalSize method corresponds to the Scan Control's ScanGetPhysicalSize method in earlier versions of the ImageKit

[Differences from the ImageKit7 ActiveX]
When the UnitMode property is 5(ikScanPixel), the corresponding size can be retrieved from the resolution values.