
Table 1-2 Authentication macros
Macro Type Description
Authentication.UserName string Logged in user name.
Authentication.Password string User password (optional).
Authentication.Email string Email of the user logged.
Authentication.Domain string Domain of the user logged.
Scan
Parameters generated before, during, and after a scan process are executed. Any of the macros described
below can be used to retrieve scan information.
1. With the suffix “_Last”, “_This”, or _Back(1)” e.g. Scan.Name_Last. In this case we get the value of the
property corresponding to the last scan process executed.
2. With the suffix “_Back(N)” where “N” can be any positive integer. e.g. Scan.Name_Back(3). In this case
we get the value of the property corresponding to the N
th
last scan process executed.
3. With the suffix “_[ScanID]”, e.g Scan.Name_IDofMyScanNode. In this case we get the value of the
property corresponding to last scan with ID ScanID.
4
. As is, e.g. Scan.Name. In this case:
a
. If used within a loop on scan nodes, the macro returns the property of the corresponding scan
node.
b
. If used anywhere else, the macro returns value of the property corresponding to the last scan,
similar to case (i).
Table 1-3 Scan macros
Macro Type Description
Scan.Name string Name of the scan process.
Scan.Timestamp DateTime The moment the scan was executed.
Scan.Timestamp.YYYYmmdd-HHmmsss DateTime The moment the scan was executed, formatted
according to the custom .NET date and time format
string provided. Any valid .NET date and time format
string can be used.
Scan.Result string Result of the scan process. Possible values:
CANCELED, SUCCESS, ERROR.
Scan.ResultMessage string Message of the scan process if error.
Scan.ScanNumPages int Number of scanned pages.
Scan.FileCount int Number of files created.
Scan.Files List<string> List of paths where the scan files are stored, in order
of creation.
Scan.Location string Path where scan process files are stored.
Scan.ScanBasicOptions.ColorMode ColorMode Color or black & white, e.g. Color.
Scan.ScanBasicOptions.CropMode CropMode Crop mode configuration: On/Off.
Section 1.4 HP Embedded Capture (HP EC) functionality 13
Komentáře k této Příručce