Excella API OCX PROGRAMMING REFERENCE MANUAL PART NUMBER 99875557-1 AUGUST 2011 Confidential This document contains the proprietary information of MagTek. Its receipt or possession does not convey any rights to reproduce or disclose its contents or to manufacture, use or sell anything it may describe. Reproduction, disclosure or use without specific written authorization of MagTek is strictly forbidden.
Copyright© 2001-2011 MagTek®, Inc. Printed in the United States of America Information in this document is subject to change without notice. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of MagTek, Inc. MagTek is a registered trademark of MagTek, Inc. ExcellaTM is a trademark of MagTek, Inc. Microsoft® is a trademark of Microsoft, Inc. REVISIONS Rev Number 1.
SOFTWARE LICENSE AGREEMENT IMPORTANT: YOU SHOULD CAREFULLY READ ALL THE TERMS, CONDITIONS AND RESTRICTIONS OF THIS LICENSE AGREEMENT BEFORE INSTALLING THE SOFTWARE PACKAGE. YOUR INSTALLATION OF THE SOFTWARE PACKAGE PRESUMES YOUR ACCEPTANCE OF THE TERMS, CONDITIONS, AND RESTRICTIONS CONTAINED IN THIS AGREEMENT. IF YOU DO NOT AGREE WITH THESE TERMS, CONDITIONS, AND RESTRICTIONS, PROMPTLY RETURN THE SOFTWARE PACKAGE AND ASSOCIATED DOCUMENTATION TO ABOVE ADDRESS ATTENTION: CUSTOMER SUPPORT.
TABLE OF CONTENTS SECTION 1. FEATURES AND SPECIFICATIONS .................................................................................... 1 INTRODUCTION ...................................................................................................................................... 1 SECTION 2. METHODS .............................................................................................................................. 3 CLOSEDEVICE METHOD....................................................
SECTION 1. FEATURES AND SPECIFICATIONS INTRODUCTION This document describes the properties, methods and events provided by the ActiveX component to communicate with MagTek Excella. For Additional Information, Please refer to the Excella manual.
Excella API OCX 2
SECTION 2. METHODS CLOSEDEVICE METHOD Closes the device with the given device name. Syntax Result =MTEXCELLAAPI1.CloseDevice (DeviceName As String) As Long Part Description DeviceName A string that specifies the name of the device to close. Data Type Long DEVICECONNECT METHOD Connects host to a device that has the given IP address or a DNS name. Syntax Result =MTEXCELLAAPI1.
Encrypting SPI IntelliHead DEVICEDISCONNECT METHOD Disconnects the device that has the given IP address or DNS name. Syntax Result =MTEXCELLAAPI1.DeviceDisconnect (ByVal lpszDevice As String) as Long Part Description lpszDevice A string that contains the IP address or DNS name of the device. Data Type Long GETDEVICE METHOD Returns the device name of the device present in the system. Syntax Result =MTEXCELLAAPI1.
Remarks GetDeviceWeb functions identically to GetDevice. GetDeviceWeb is intended to be used for webpage applications. Data Type Long GETIMAGE METHOD Gets the image data results from a previous scan. Syntax Result =MTEXCELLAAPI1.GetImage (ByVal lpszDeviceName As String, ByVal lpszImageID As String, ByRef lpszImageBuffer As String, ByRef lplImageSize As Long) as Long Part Description lpszDeviceName A string that specifies the name of the device.
Encrypting SPI IntelliHead Part Description lpszDeviceName A string that specifies the name of the device. lpszOptions A string that specifies all the key/value pairs. lplImageIndex A string that specifies the Key Index Number. lpbConvertCRLF A boolean that when set to true will indicate to remove the carriage return and line feed characters from the return value. lpReturnValue A variant that stores the image data.
GETIMAGEWEB METHOD Gets the image data results from a previous scan. Syntax Result =MTEXCELLAAPI1. GetImageWeb ( ByVal lpszDeviceName As String, ByVal lpszImageID As String, ByVal lpszImageFile As String, ByRef lpszImageBuffer As Variant, ByRef lplImageSize As Variant) as Long Part Description lpszDeviceName A string that specifies the name of the device. lpszImageID A string that specifies the identification of the requested image.
Encrypting SPI IntelliHead Data Type Long GETINDEXVALUEWEB METHOD Retrieves a key/value pair that was previously stored in the Document Information. Syntax Result =Result = MTEXCELLAAPI1.GetIndexValueWeb (ByVal lpszOptions As String, ByVal lpszSection As String, ByVal lpszKey As String, ByVal lpiIndex As Long, ByRef lpszResult As Variant, ByRef lplBufferSize As Variant ) as Long Remarks GetIndexValueWeb functions identically to GetIndexValue.
Part Description lpszOptions A string that specifies all the key/value pairs. lpszSection A string containing the section name. lpszKey A string containing the key name. lpszResult The buffer that receives the retrieved value. lplBufferSize The size of the result buffer. Data Type Long GETVALUEWEB METHOD Retrieves a key/value pair that was previously stored in the Document Information. Syntax Result =MTEXCELLAAPI1.
Encrypting SPI IntelliHead LOGENABLE METHOD Enables or disables logging. Syntax Result =MTEXCELLAAPI1.LogEnable (ByVal bEnable As Integer ) Part Description bEnable A value of true enables logging. OPENDEVICE METHOD Opens the device with the given device name. Syntax Result =MTEXCELLAAPI1.OpenDevice (ByVal lpszDeviceName As String ) as Long Part Description lpszDeviceName A string that specifies the name of the device.
PROCESSCHECKWEB METHOD Sends a scan check request with the given process options to a device. Syntax Result =MTEXCELLAAPI1.ProcessCheckWeb (ByVal lpszDeviceName As String, ByVal lpszOptions As String, ByRef lpszDocInfo As Variant, ByRef lplDocInfoSize As Variant) as Long Part Description lpszDeviceName A string that specifies the name of the device. lpszOptions A string that specifies all the key/value pairs. lpszDocInfo A variant containing the information returned from the device.
Encrypting SPI IntelliHead QUERYINFOWEB METHOD Retrieves data of a given section name from a device. Syntax Result =MTEXCELLAAPI1.QueryInfoWeb (ByVal lpszDeviceName As String, ByVal lpszQueryParam As String, ByRef lpszResult As Variant, ByRef lplLength As Variant) as Long Part Description lpszDeviceName A string that specifies the name of the device. lpszQueryParam A string containing the section name. e.g. DeviceCapabilities, DeviceUsage, DeviceStatus, etc.
SAVEIMAGEBYINDEXWEB METHOD Gets the image data results from a previously scan. Syntax Result =MTEXCELLAAPI1. SaveImageByIndexWeb (ByVal lpszDeviceName As String, ByVal lpszDocInfo As String, ByVal lplImageIndex As Long, ByVal lpszImgFileName As String) as Long Part Description lpszDeviceName A string that specifies the name of the device. lpszDocInfo A string containing the information previously returned from the device.
Encrypting SPI IntelliHead SAVEIMAGEBYURLWEB METHOD Gets the image data results from a previously scan. Syntax Result =MTEXCELLAAPI1. SaveImageByURLWeb (ByVal lpszDeviceName As String, ByVal lpszDocInfo As String, ByVal lpszImageURL As String, ByVal lpszImgFileName As String) as Long Part Description lpszDeviceName A string that specifies the name of the device. lpszDocInfo A string containing the information previously returned from the device.
SENDCOMMANDWEB METHOD Sends a command to a device. Syntax Result =MTEXCELLAAPI1. SendCommandWeb (ByVal lpszDeviceName As String, ByVal lpszCommand As String, ByRef lpszResult As Variant, ByRef lplLength As Variant) as Long Part Description lpszDeviceName A string that specifies the name of the device. lpszCommand A string containing the command to sent to the device. lpszResult The buffer that receives the result of the command. lplLength The length of lpszResult.
Encrypting SPI IntelliHead SETINDEXVALUEWEB METHOD Adds a key/value pair to the given device settings with an index number. Syntax Result =MTEXCELLAAPI1. SetIndexValueWeb (ByVal lpszSection As String, ByVal lpszKey As String, ByVal lpiIndex As Long, ByVal lpszValue As String, ByRef lplBufferSize As Variant, ByRef lpszOptions As Variant) as Long Part Description lpszSection A string containing the section name. lpszKey A string containing the key name. lpiIndex The key index number.
SETLOGLEVEL METHOD Sets the desired level of logging details. Syntax Result =MTEXCELLAAPI1. SetLogLevel (ByVal lpLevel As Long) Part Description lpLevel This value specifies the type of logging details. The value is composed of one or more of the following: DBGLOG_DLL_INTERNAL = 0x0001 DBGLOG_DLL_EXTERNAL = 0x0002 DBGLOG_DLL_XMLDATA = 0x0004 DBGLOG_DLL_IMAGEDATA = 0x0010 SETVALUE METHOD Adds a key/value pair to the given device settings. Syntax Result =MTEXCELLAAPI1.
Encrypting SPI IntelliHead SETVALUEWEB METHOD Adds a key/value pair to the given device settings. Syntax Result =MTEXCELLAAPI1. SetValueWeb (ByVal lpszSection As String, ByVal lpszKey As String, ByVal lpszValue As String, ByRef lplBufferSize As Variant, ByRef lpszOptions As Variant) as Long Part Description lpszSection A string containing the section name. lpszKey A string containing the key name. lpszValue A string containing the key value to be set. lplBufferSize The size of the value buffer.
