Cslibcorescanner_xml.h File Reference

Define the methods provided by CoreScanner. More...

#include <cstddef>
#include <vector>
#include <string>
#include <CsUserDefs.h>
#include <CsIEventListenerXml.h>

Go to the source code of this file.

Functions
unsigned short	Open (IEventListenerXml *pEventListener, unsigned int scannerTypeFlags, StatusID *status)
unsigned short	GetScanners (unsigned short *numberOfScanners, std::vector< unsigned int > *scannerIDList, std::string &outXML, StatusID *status)
unsigned short	GetScannerIdList (unsigned short *numberOfScanners, std::vector< unsigned int > *scannerIDList, StatusID *status)
void	RefreshDevicelTopology ()
unsigned short	ExecCommand (unsigned int opcode, const std::string inXML, std::string &outXML, StatusID *status)

Detailed Description

Define the methods provided by CoreScanner.

Function Documentation

unsigned short ExecCommand	(	unsigned int	opcode,
		const std::string	inXML,
		std::string &	outXML,
		StatusID *	status
	)

Synchronously executes a command. Function is timed blocking

Returns

status of the method

Parameters

[in]	opcode	Opcode
[in]	inXML	Input XML
[out]	outXML	Output XML
[out]	status	Status of the method execution

unsigned short GetScannerIdList	(	unsigned short *	numberOfScanners,
		std::vector< unsigned int > *	scannerIDList,
		StatusID *	status
	)

added for version 1.3.1 New function to get only ID list of scanners connected with CoreScanner usage: device list is required to trigger RefreshDeviceTopology()

Returns

status of the method

Parameters

[out]	numberOfScanners	Number Of Scanners
[out]	scannerIDList	[in] Scanner ID List
[out]	status	Status of the method execution

unsigned short GetScanners	(	unsigned short *	numberOfScanners,
		std::vector< unsigned int > *	scannerIDList,
		std::string &	outXML,
		StatusID *	status
	)

Retrieves the list of connected scanners of interested type

Returns

status of the method

Parameters

[out]	numberOfScanners	Number Of Scanners
[out]	scannerIDList	[in] Scanner ID List
[out]	outXML	Output XML
[out]	status	Status of the method execution

unsigned short Open	(	IEventListenerXml *	pEventListener,
		unsigned int	scannerTypeFlags,
		StatusID *	status
	)

Opens a connection to the CoreScanner

Returns

status of the method

Parameters

[in]	pEventListener	Pointer to the eventListener
[in]	scannerTypeFlags	Scanner type flags
[out]	status	Status of the method execution

void RefreshDevicelTopology

(

)

added for version 1.3.1 function to refresh topology of each device. usage: re-enumurate devices.