LabelFile object

First available in SystemsLink: 2014.2

Used by External SystemsLink for TMWSuite.

Methods

The Return Value for all methods is LabelFile.ReturnObject.
Method Name Parameters Trailer.ReturnObject.
ReturnCode		 Description

Name

Data type (in C#)

RetrieveLabelFiles

labelFileDefinition

LabelNames

0 = successful

1000 = errors occurred

Returns all LabelFile objects that meet the provided criteria

GetLabelFile

labelFileDefinition

LabelNames

0 = successful

100 = no records found

1000 = errors occurred

Gets all LabelFile objects that fit the provided label file definition and contain the provided abbreviation

abbr

string

GetLabelFileUserLabelName

labelFileDefinition

LabelNames

0 = successful

100 = no records found

1000 = errors occurred

Gets all LabelFile objects that fit the provided label file definition and do not contain an abbreviation

Properties and column mapping

To condense the information in this table, the Database Column Name uses the following abbreviations for database tables:

l = labelfile
Property Database Column Modifiable Comments

Name

Data Type (in C#)

Name

Data Type

1

Abbr

string

l.abbr

varchar(6)

Insert/Update

2

AutoComplete

bool

l.auto_complete

char(1)

Insert/Update

3

Code

int

l.code

int

Insert/Update

4

CreateMove

bool

l.create_move

char(1)

Insert/Update

5

DataSourceID

string

N/A

Not mapped

6

EdiDode

string

l.edicode

varchar(6)

Insert/Update

7

InventoryItemFlag

bool

l.inventory_item

varchar(1)

Insert/Update

8

IsDirty

bool

N/A

Not mapped or used in service

9

IsNew

bool

N/A

Not mapped, set to false during save to update

10

IsValid

bool

N/A

Not mapped or used in service

11

LabelDefinition

string

l.labeldefinition

varchar(20)

Insert/Update

12

LabelExtrastring1

string

l.label_extrastring1

varchar(60)

Insert/Update

13

LabelExtrastring2

string

l.label_extrastring2

varchar(60)

Insert/Update

14

LockedFlag

bool

l.locked

char(1)

Insert/Update

15

Name

string

l.name

varchar(20)

Insert/Update

16

RetiredFlag

bool

l.retired

char(1)

Insert/Update

17

SystemCodeFlag

bool

l.systemcode

char(1)

Insert/Update

18

UpdateableProperties

LabelFileUpdateInfo

N/A

Not mapped

19

UserLabelName

string

l.userlabelname

varchar(20)

Insert/Update

LabelFile.ReturnObject

Property Name Data Type (in C#) Comments

1

ErrorMessages

List <string>

2

ErrorObjectIndexList

List <int>

3

Exceptions

List <Exception>

4

ReferenceObjects

List <LabelFile>

5

ReturnCode

int

6

ReturnValue

string

7

TraceMessages

List <string>

8

WarningMessages

List <string>

LabelFileUpdateInfo object

  • Data types (in C#) for all properties are bool.

  • Set the property to true to update the corresponding LabelFile property.
Property Name

1

Abbr

2

AutoComplete

3

Code

4

CreateMove

5

EdiDode

6

InventoryItemFlag

7

LabelDefinition

8

LabelExtrastring1

9

LabelExtrastring2

10

LockedFlag

11

Name

12

RetiredFlag

13

SystemCodeFlag

14

UserLabelName