IKScanGetPixelType

This function retrieves the pixel type supported by the scan device

[C++Builder/Visual C++] DWORD IKScanGetPixelType(HANDLE AppHandle, HANDLE SrcHandle, LPCSTR ScanDsName, WORD *List, WORD ListNum);

[Delphi] function IKScanGetPixeltype(AppHandle, SrcHandle: THandle; ScanDsName: PAnsiChar; var List: Word; ListNum: Word): DWORD;

[Visual Basic] Function IKScanGetPixeltype(ByVal AppHandle As Long, ByVal SrcHandle As Long, ByVal ScanDsName As String, List As Integer, ByVal ListNum As Integer) As Long

Parameters

Name	Explanation
AppHandle	The application handle retrieved by IKScanInitialize
SrcHandle	The scan device handle retrieved by IKScanOpenDS or 0
ScanDsName	The datasource name (Required when SrcHandle is 0)
List	An array containing the bit depths supported by the scan device In C++Builder and Visual C++, pass the pointer to the first element in the array. In Delphi, the arguments are returned in the first element of the array List[0]. In Visual Basic, the arguments are returned in the first element of the array List(0).
ListNum	The number of elements in the List array

Return Value

When List and ListNum are set
Returns the retrieved number of pixel types. 0 indicates that an error has occurred, please refer to the error status.

When List is NULL or ListNum is 0
Returns the necessary number of elements needed in the array to retrieve pixel types

Explanation

If using the value retrieved from IKScanOpenDS in SrcHandle, then no other application can use the opened datasource (scan device) until the datasource is closed. The values retrieved in the List array will range from 0 to 3 and can be set in the IKSCAN_EXEC member variable, PixelType. For more information about IKSCAN_EXEC, please refer to the "Structure Definitions and Explanation" in the Ik8Scan.dll, Ik8ScanA.dll, Ik8Scan64.dll, Ik8Scan64A.dll section. If SrcHandle is 0 and ScanDsName is blank then you must execute the IKScanSelect function. ("" or null means the datasource selected by IKScanSelect will be used)

This function has been maintained for compatibility with the ImageKit5. The IKScanGetCapEnum method can also retrieve the pixel types supported by a scan device.

[Differences from the ImageKit5]

Function Name          Parameters
IK5ScanGetPixeltype:    hWnd, ScanDsName, List, ListNum
IKScanGetPixelType:     AppHandle, SrcHandle, ScanDsName, List, ListNum

The "T" in the PixelType parameter has been capitalized. Since the ImageKit6, hWnd is passed by IKScaninitialize and the return value, AppHandle, is used.