Open topic with navigation

SubString Response Tag

ClosedDescription

Returns the description of the data sources in the objects that appear on the template. There can be multiple SubString tags in an <Object> tag.

ClosedSyntax

<SubString Position=Value Sharename=Value Type=Value>...</SubString>

The supported attributes include:

Attribute

Description

Position

Returns the position of the data source.

Sharename

Returns the name of the data source's share name. Must appear if the data source has a share name.

Type

Returns the data source type. The available types include:

  • Screen data
  • Database field
  • Date
  • Time
  • Label Object String
  • Printer Code Template Field
  • Visual Basic Script
  • Prompt at Print

ClosedChild Elements

The following child element tags are supported:

Tag

Description

Value

Describes the individual data source value.

ClosedParent Tag

<Object>

ClosedExample

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

...

</Summary>

<Pages TotalLabels="2" TotalPages="2" MediaHandling="true">

<Page PrintedPageNumber="2" TotalPages="2" Status="Printed" MediaHandlingAction="Pause">

<Label Position="1">

<Object Name="Text 1" Type="Text">

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

<Value>John Doe</Value>

</SubString>

<SubString Position="2" ShareName="Sub-String 2" Type="Date">

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

</SubString>

</Object>

<Object Name="RFID 1" Type="RFID">

<SubString Position="1" ShareName="RFIDCode" Type="Database">

<Value>30705E30A700004000000001</Value>

</SubString>

</Object>

</Label>

<Label Position="2">

<Object Name="Text 1" Type="Text">

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

<Value>John Doe</Value>

</SubString>

<SubString Position="2" ShareName="Sub-String 2" Type="Date">

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

</SubString>

</Object>

<Object Name="RFID 1" Type="RFID">

<SubString Position="1" ShareName="RFIDCode" Type="Database">

<Value>30705E30A700004000000002</Value>

</SubString>

</Object>

</Label>

</Page>

</Pages>

</PrintData>

<Message ID="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>

ClosedRequirements

BTXML Script version 2.0 (BarTender 9.0 and higher)