Show TOC

Object documentationTmxLabel Interface

 

The following properties define the dynamic behavior of the TmxLabelobject:

Name

COM Type

Description

LastErrorNumber

VARIANT

The error code returned if there is an error. For known ADO error, the return value is the value returned from ADO function. If it is unknown ADO error, the value is 0x8000FFAAL.

LastError

VARIANT

The message displayed if there is an error. If it is known ADO error, the description is return from ADO Error object. If it is unknown ADO error, the description specifies the method name where the error occurs.

Method

HRESULT InsertLabelPrintQueue (VARIANT Labeltype, BSTR Description, BSTR Plunum, VARIANT Numofcopy, VARIANT Formatid, BSTR Xrefnum)

This method is used to insert a record into tables print_queue and print_queue_dtl. The queue id will be assigned automatically by the system.

When there is an error, two properties (LastErrorNumber and LastError ) should be used to determine the code of the error and proper description. For LastErrorNumber, there are mainly two categories: known ADO error and unknown ADO error. For known ADO error, both LastErrorNumber and LastError are returned as the values returned from ADO. For unknown ADO error, the error code is 0x8000FFAAL and the description is based on which function causes the failure.

Parameters

VARIANT Labeltype

Type of label to be printed.

1 - Sticker Label

2 - Shelf Label

BSTRDescription

Description for this label print job.

BSTR Plunum

The PLU number of the label to be printed.

VARIANT Numofcopy

The number of copy of the label to be printed.

VARIANT Formatid

The format ID of the label to be printed.

BSTR Xrefnum

Cross reference number.

Return

S_OK

If the record is successfully inserted.

S_FALSE

If there is an error during the insertion.