Open topic with navigation

Returning Print Data in the Response

The ReturnPrintData attribute displays the summary data and the template information, depending on how the ReturnSummaryData and ReturnLabelData attributes are set. When you set the <Print> command's ReturnPrintData attribute to true and do not include any other attribute, the response includes the print job details, a summary of the print job, and the individual item information. When you set either the ReturnSummaryData or ReturnLabelData attributes to false, their information is removed from the response.

The following example shows the response that is returned when the ReturnPrintData attribute is set to true and no other attributes are set or when the ReturnSummary, ReturnLabelData and ReturnChecksum attributes are included and also set to true. If the ReturnChecksum attribute was not included or was set to false, the checksum data in the summary would not appear.

<?xmlversion="1.0"encoding="utf-16"?>

<ResponseVersion="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>

<CommandName="Cmd1">

<PrintGUID="{C87068F8-4972-41F1-A6E8-724381703764}"JobName="MCIJob"ID="1234"JobLastStatus="Sent"JobCompleted="true">

<JobStatusCompleted="true">

<TimeJobStart>02:24:34</TimeJobStart>

<TimeJobQueued>02:24:34</TimeJobQueued>

<TimeJobSent>02:24:34</TimeJobSent>

<LastStatus>Sent</LastStatus>

<Description>Finished sending print job to printer.</Description>

</JobStatus>

<PrintData>

<Summary>

<CommandLine>/AF="Document1.btw" /P</CommandLine>

<FormatGUID>C87068F8-4972-41F1-A6E8-724381703764</FormatGUID>

<FormatName>Document1.btw</FormatName>

<FormatLastModified>12:10:34 04/20/2007</FormatLastModified>

<FormatChecksumBarTenderVersion="900"All="12AB34E7">

<ObjectName="Barcode 1"Type="Barcode"Checksum="36874221">

</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>

<LogPrintJob>false</LogPrintJob>

<AutoPrintAgain>false</AutoPrintAgain>

<EnablePrinterCodeModifier>false</EnablePrinterCodeModifier>

<PrintToFile>false</PrintToFile>

<ShowPrinterCode>false</ShowPrinterCode>

<EnablePrompting>true</EnablePrompting>

<RefreshDatabases>false</RefreshDatabases>

</PrintSetupOptions>

<Performance>

<AllowFormatCaching>false</AllowFormatCaching>

<AllowGraphicsCaching>false</AllowGraphicsCaching>

<AllowSerialization>true</AllowSerialization>

<AllowStaticGraphics>true</AllowStaticGraphics>

<AllowStaticObjects>false</AllowStaticObjects>

<AllowVariableDataOptimization>false</AllowVariableDataOptimization>

<WarnWhenUsingTrueTypeFonts>true</WarnWhenUsingTrueTypeFonts>

</Performance>

<ObjectPrintMethod>

<TrueTypeText>TextOutput</TrueTypeText>

<Unsupported1DBarCodes>Auto</Unsupported1DBarCodes>

<Unsupported2DBarCodes>Auto</Unsupported2DBarCodes>

<Lines>Auto</Lines>

<Boxes>Auto</Boxes>

<Ellipses>Auto</Ellipses>

</ObjectPrintMethod>

<MediaHandling>

<Action>btMHPageBreak</Action>

<DataItemName>TheDataItemName</DataItemName>

<DataItemType>btMHNamedSubString</DataItemType>

<IgnoreCase>true</IgnoreCase>

<Occurrence>btMHAfterDataChange</Occurrence>

</MediaHandling>

<LicenseServerCheck>

<Address>Server Address</Address>

<Port>5160</Port>

<CheckResult>true</CheckResult>

<Timeout>15000</Timeout>

<Retries>3</Retries>

<AsyncCheck>true</AsyncCheck>

<CheckReason>0</CheckReason>

</LicenseServerCheck>

<TotalLabels>2</TotalLabels>

<TotalPages>1</TotalPages>

</Summary>

<PagesTotalLabels="2"TotalPages="2"MediaHandling="true">

<PagePrintedPageNumber="2"TotalPages="2"Status="Printed"MediaHandlingAction="Pause">

<LabelPosition="1">

<ObjectName="Text 1"Type="Text">

<SubStringPosition="1"ShareName="Sub-String 1"Type="Screen Data">

<Value>John Doe</Value>

</SubString>

<SubStringPosition="2"ShareName="Sub-String 2"Type="Date">

<Value>4/24/2007</Value>

</SubString>

</Object>

<ObjectName="RFID 1"Type="RFID">

<SubStringPosition="1"ShareName="RFIDCode"Type="Database">

<Value>30705E30A700004000000001</Value>

</SubString>

</Object>

</Label>

<LabelPosition="2">

<ObjectName="Text 1"Type="Text">

<SubStringPosition="1"ShareName="Sub-String 1"Type="Screen Data">

<Value>John Doe</Value>

</SubString>

<SubStringPosition="2"ShareName="Sub-String 2"Type="Date">

<Value>4/24/2007</Value>

</SubString>

</Object>

<ObjectName="RFID 1"Type="RFID">

<SubStringPosition="1"ShareName="RFIDCode"Type="Database">

<Value>30705E30A700004000000002</Value>

</SubString>

</Object>

</Label>

</Page>

</Pages>

</PrintData>

<MessageID="1606"GUID="{8A8E8550-C822-4e84-8713-212793DFD6E1}"Severity="Information"Category="Miscellaneous"Response="OK">

<Text>

BarTender successfully sent the print job to the spooler.

Job Name: MyJobName

BarTender Document: Document1.btw

Printer: Datamax H-4212 7.1.4

</Text>

</Message>

</Print>

</Command>

</Response>