visit Kofax web site

ScannerMessage Class Reference

List of all members.

Detailed Description

Messages / Translations for Scanner capture and image cleaning module.


Public Member Functions

 readXML (&$xml)
 Read an XML descriptor.
 ScannerMessage ($id, $msg)
 Constructor.
 writeXML (&$xml)
 Write the XML descriptor.

Public Attributes

 $mId
 Identifyer of the message, String, required.
 $mMsg
 The message, UTF8 String, required.

Constructor & Destructor Documentation

ScannerMessage.ScannerMessage (  $  id,
$  msg
) 
 

Constructor.

Parameters:
$id [in] Identifier, one of the following:
  • DeviceBusy
  • DeviceOffline
  • DeviceParameterUnsupported
  • DeviceNotSelected
  • ScanImagesMissing
  • CannotReadFile
$msg [i] UTF8 String, the appropriate message string

Member Function Documentation

ScannerMessage.readXML (  &$  xml  ) 
 

Read an XML descriptor.

ScannerMessage.writeXML (  &$  xml  ) 
 

Write the XML descriptor.

Member Data Documentation

ScannerMessage.$mId
 

Identifyer of the message, String, required.

ScannerMessage.$mMsg
 

The message, UTF8 String, required.

The documentation for this class was generated from the following file: