Description
Object Response Tag (FormatChecksum) |
Description
Returns the checksum value for an object on a label. Checksum digits for individual label objects are calculation numbers that record the information about the object at a specific point in time.
If you want to reprint the label at a later date, you can compare the checksum digit that was first recorded for that object to the checksum digit for the object that you are about to print to determine whether the two numbers match. If they match, it is confirmed that the object has not changed. If they do not match, it is confirmed that the object has changed. When you know the objects are different, you can decide whether you want to change the data so that the objects match again or to print the new label with the changed object.
Syntax
<Object Name=Value Type=Value Checksum=Value>...</Object>
The supported attributes include the following.
|
Attribute |
Description |
|---|---|
|
Name |
The name of the object. |
|
Type |
The type of object. For a list of object types, refer to the <Object> tag in the Pages label data response. |
|
Checksum |
The checksum value that is equal to the object. The value is a 32-bit hex number. |
Parent Tag
Example
<?xml version="1.0" encoding="utf-16"?>
<Response Version="2.0" Name="09232006_103601_Job1" ID="123" AppName="BarTender" AppVersion="9.00" AppVersionId="900" AppVersionMajor="9" AppVersionMinor="00" AppVersionBuild="2345" AppInstancePid="12345" AppInstanceGUID="(5EFC7975-14BC-11CF-9B2B-00AA00573819)">
<User>Administrator</User>
<Server>MyServer</Server>
<Command Name="Cmd1">
<Print GUID="{C87068F8-4972-41F1-A6E8-724381703764}" JobName="MCIJob" ID="1234" JobLastStatus="Sent" JobCompleted="true">
<JobStatus Completed="true">
...
</JobStatus>
<PrintData>
<Summary>
<CommandLine>/AF="Format1.btw" /P</CommandLine>
<FormatGUID>C87068F8-4972-41F1-A6E8-724381703764</FormatGUID>
<FormatName>Label1.btw</FormatName>
<FormatLastModified>12:10:34 04/20/2007</FormatLastModified>
<FormatChecksum BarTenderVersion="900" All="FFE2CC9F" Page-Setup="655FDE47" ObjectPrintMethod="2133DF1C" PCMActions="00000000" PCMScript="00000000">
<Object Name="Text1" Type="Text" Checksum="7D6EA0D3">
</FormatChecksum>
<NumberSerializedLabels>5</NumberSerializedLabels>
<NumberIdenticalCopies>1</NumberIdenticalCopies>
<UseDatabase>false</UseDatabase>
<QueriedRecords>All</QueriedRecords>
<RecordRange>1...</RecordRange>
<Printer>HP LaserJet</Printer>
<PrinterModel>HP LaserJet1200</PrinterModel>
<PrinterPort>LPT1</PrinterPort>
<PrinterHost>MyServer</PrinterHost>
<PrinterComment>User Entered Comment</PrinterComment>
<Date>2008-03-19T14:14:41</Date>
<LabelWidth>100</LabelWidth>
<LabelHeight>100</LabelHeight>
<PageRows>2</PageRows>
<PageColumns>5</PageColumns>
<PrintSetupOptions>
...
</PrintSetupOptions>
<Performance>
...
</Performance>
<ObjectPrintMethod>
...
</ObjectPrintMethod>
<MediaHandling>
...
</MediaHandling>
<LicenseServerCheck>
...
</LicenseServerCheck>
<TotalLabels>2</TotalLabels>
<TotalPages>1</TotalPages>
</Summary>
</PrintData>
<Message ID="1606" GUID="{8A8E8550-C822-4e84-8713-212793DFD6E1}" Severity="Information" Category="Miscellaneous" Response="OK">
...
</Message>
</Print>
</Command>
</Response>
Requirements
BTXML script version 2.0 (BarTender 9.0 and later versions)
Related Topics