Response Tag

ClosedDescription

For every BarTender XML (BTXML) script that prints a label or exports an image, an XML response is generated. Simple responses contain information about error messages, print job completion status, and custom data that is specific to the command that was run. More complex responses can include summary information about the entire print job and detailed data about each label. The attributes that are used to determine the content of the response are located in the <Print> tag.

A response starts with a <Response> root tag and contains one or more <Command> tags that represent a response for a specific BTXML script command. To view a response example, refer to <Response>.

ClosedSyntax

<Response Version=Value [Name=Value] [ID=Value] AppName=Value AppVersion=Value AppVersionID=Value AppVersionMajor=Value AppVersionMinor=Value AppVersionBuild=Value AppInstancePid=Value AppGuid=Value>...</Response>

Where ... indicates the response tags.

The <Response> tag has the following attributes.

Attribute

Description

Version

XML response version.

Name

The unique request name.

ID

The unique ID value as specified by using the <XMLScript> ID attribute.

AppName

The application name.

AppVersion

The application version.

AppVersionID

The integer value that defines the application version. For example, the version ID for version 9.00 is 900.

AppVersionMajor

The major number of the version of the application. For example, the major number of version 9.00 is 9.

AppVersionMinor

The minor number of the version of the application. For example, the minor number of version 9.00 is 00.

AppVersionBuild

The build number of the application.

AppInstancePid

The application process ID as an integer.

AppInstanceGUID

The application's GUID value.

ClosedChild Elements

The following child element tags are supported.

Tag

Description

Command

Defines the command response.

Server

Defines the server.

User

Defines the user.

ClosedRequirements

BTXML script version 2.0 (BarTender 9.0 and later versions)

Related Topics