CognitiveTPG B780 - Manual (Page 155)

Chapter 5: Programming commands 143
A776-PG00001 C 12/09 A776 (B780) Programming Guide
Free Image
Hexadecimal: 1D BB nL nH
Parameters: nL nH is the FileIndex of the image buffer space to be released.
Return: 1D 49 BB s nL nH, where nL nH is the count of typical images that can be stored in free space in circular buffer
order. S = 0 means buffer space was marked free, S = 1 no buffered image at the specified index.
Description: This frees the space used by the image with FileIndex n for subsequent use in future image acquisition.
The image at FileIndex n will no longer be available for attribute listing or transmitting. The host should free images
that will never be retrieved; images that have been transmitted successfully will be automatically freed when their
space is needed for a new image.
Free Imager Buffering
Hexadecimal: 1D BC m
Parameters: m = 0 free all buffered images and all application set scan identifying properties (TIFF tags), m = 1: only
free buffered images, m =2 only free application set TIFF tags.
Return: This command returns 1D 49 BC s nL nH, where nL nH is the maximum count of typical images that can be
stored in free space in circular buffer order. S is a status byte, and it always returns as 0.
Description: This frees all the space used for image buffering and/or application set pending tags. A status is returned
giving the image buffer size in number of typical documents that can fit.
Get Buffered Image List
Hexadecimal: 1D BD
Parameters: none
Return: 1D 49 BD nL nH [FI-1 FI-2…)]
nL nH gives the size of the list in bytes, which is 3X the number of FileIndex’s currently stored. Each Index report FI-X is
3 bytes: s status = 0 image not transmitted, s = 1 transmitted, and a 2 byte index in nL nH form. For example if there
were two scanned documents in the list, the return would be: 1D 49 BD 6 0 s1 nL1 nH1 s2 nL2 nH2. If there are no
FileIndexes stored then n = 0 is returned without any FileIndex values.
Description: Content of the buffer is described by a FileIndex list for all transmittable images using the structure
above.
Get Buffered Image Attributes
Hexadecimal: 1D BE nL nH
Parameters: nL nH is the File Index of the image for which to return all its TIFF attributes.
Return: 1D 49 BE s (1 byte status), nL nH (index #). This is followed by mL mH, a 2 byte count of return length in bytes
and then all the TIFF tags are returned in the same structure used to set the tags via command Set Scan Identifying
Properties.
The values of s are: 0 = OK, 1= not in buffer; this will also set the count of tags to 0.
Description: The attributes (Tiff tags) that were present at the time of scan for the given file index are returned, in the
same format as used in the Set Scan Identifying Properties command.