DLL Function

int CCI_Return = ScSetEntityStringData(string Entity_Name, int Data_ID, string Format_String)

int CCI_Return = ScGetEntityStringData(string Entity_Name, int Data_ID, ref string Format_String)

ASCII Function

int CCI_Return = ScCciSetEntityStringData(string Entity_Name, int Data_ID, string Format_String)

string Format_String = ScCciGetEntityStringData(string Entity_Name, int Data_ID)

Description

Set or get the format of a Barcode (if supported).

Entity_Name

Type: string

Unit: none

Specify the entity name to be changed.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlStringDataIdBarCodeFormatString

32

Format_String

Type: string

Unit: none

The barcode format.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: For the entity "Barcode1" set the barcode format to "2,2,2,2":

int CCI_Return = cci.ScSetEntityStringData( "Barcode1", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlStringDataIdBarCodeFormatString, "2,2,2,2" );

C# Example: Get the barcode format string of the entity "Barcode1":
 
string Format_String = "";

int CCI_Return = cci.ScGetEntityStringData( "Barcode1", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlStringDataIdBarCodeFormatString, ref Format_String );

DLL Function

int CCI_Return = ScSetEntityLongData(string Entity_Name, int Data_ID, int Parameter)

int Parameter = ScGetEntityLongData(string Entity_Name, int Data_ID)

ASCII Function

int CCI_Return = ScCciSetEntityLongData(string Entity_Name, int Data_ID, int Parameter)

int Parameter = ScCciGetEntityLongData(string Entity_Name, int Data_ID)

Description

Set or get the barcode level and the barcode mode.

Entity_Name

Type: string

Unit: none

Specify the entity name to be changed.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdDataBarcodeLevel

108

Barcode level as in the barcode extended settings.

scComSAMLightClientCtrlLongDataIdDataBarcodeMode

109

Barcode mode as in the barcode extended settings.

Parameter

Type: int

Unit: none

Values are 0 based, 0 is the first entry in the list.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Set the barcode level for a QR Code Ex named "Barcode1" to "Level L (7% error correction)":

int CCI_Return = cci.ScSetEntityLongData("Barcode1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataBarcodeLevel, 0);

C# Example: Get the barcode level of barcode "Barcode1":

int Barcode_Level = cci.ScGetEntityLongData("Barcode1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataBarcodeLevel);

DLL Function

int CCI_Return = ScSetEntityLongData(string Entity_Name, int Data_ID, int Flag)

int Flag = ScGetEntityLongData(string Entity_Name, int Data_ID)

ASCII Function

int CCI_Return = ScCciSetEntityLongData(string Entity_Name, int Data_ID, int Flag)

int Flag = ScCciGetEntityLongData(string Entity_Name, int Data_ID)

Description

Set or get the state of the checkboxes int the Barcode -> Limits dialog.

Entity_Name

Type: string

Unit: none

Specify the entity to be changed.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdBarcodeFlagsHigh

138

Flag

Type: int

Flag:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdBarcodeFlagsHighLimitLength

0x1

Force length limit checkbox.

scComSAMLightClientCtrlLongDataIdBarcodeFlagsHighLimitHeight

0x2

Force height limit checkbox.

scComSAMLightClientCtrlLongDataIdBarcodeFlagsHighKeepAspect

0x4

Keep aspect checkbox.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•The values for length and height are described in Various Text Parameters.

•To prevent incorrect operation please read chapter How to work with flags.

C# Example: Enable force length limit and don't change any other flags of "bc":

int Barcode_Limits_Flags = cci.ScGetEntityLongData( "bc", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdBarcodeFlagsHigh );

Barcode_Limits_Flags = Barcode_Limits_Flags | 0x1;

int CCI_Return = cci.ScSetEntityLongData( "bc", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdBarcodeFlagsHigh, Barcode_Limits_Flags );

DLL Function

int CCI_Return = ScSetEntityDoubleData(string Entity_Name, int Data_ID, double Line_Reduction)

int CCI_Return = ScGetEntityDoubleData(string Entity_Name,  int Data_ID, ref double Line_Reduction)

ASCII Function

int CCI_Return = ScCciSetEntityDoubleData(string Entity_Name, int Data_ID, double Line_Reduction)

double Line_Reduction = ScCciGetEntityDoubleData(string Entity_Name, int Data_ID)

Description

Set or get the line reduction of the barcode in percent for reducing the size of a barcode line.

Entity_Name

Type: string

Unit: none

Specify the entity name to be changed.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlDoubleDataIdBarcodeLinereduction

69

Specify the barcode level as in the Barcode Extended settings.

Line_Reduction

Type: double

Unit: %

Line reduction in percent value.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Set the line reduction of barcode "Barcode1" to 10.5%:

int CCI_Return = cci.ScSetEntityDoubleData( "Barcode1", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlDoubleDataIdBarcodeLinereduction, 10.5 );

C# Example: Get the line reduction of the barcode "Barcode1":

double Line_Reduction = -1.0;

int CCI_Return = cci.ScGetEntityDoubleData( "Barcode1", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlDoubleDataIdBarcodeLinereduction, ref Line_Reduction );

DLL Function

int CCI_Return = ScSetEntityLongData(string Entity_Name, int Data_ID, int Flag)

int Flag = ScGetEntityLongData(string Entity_Name, int Data_ID)

ASCII Function

int CCI_Return = ScCciSetEntityLongData(string Entity_Name, int Data_ID, int Flag)

int Flag = ScCciGetEntityLongData(string Entity_Name, int Data_ID)

Description

Enable, disable or get the barcode entities parameters from the barcode properties page.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdBarcodeSetFlags

101

Enable flags and get flags.

scComSAMLightClientCtrlLongDataIdBarcodeClearFlags

102

Disable flags.

Flag

Type: int

Flag:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdBarcodeFlagVariableLength

0x1

VariableLength checkbox.

scComSAMLightClientCtrlLongDataIdBarcodeFlagInvert

0x2

Invert checkbox from Barcode Extended.

scComSAMLightClientCtrlLongDataIdBarcodeFlagDisableAutoQuietZ

0x4

Auto Quiet Zone checkbox from Barcode Extended.

scComSAMLightClientCtrlLongDataIdBarcodeFlagQuietZoneAbsolute

0x8

QuiteZone Absolute checkbox from Barcode Extended.

scComSAMLightClientCtrlLongDataIdBarcodeFlagGenerateCheckCode

0x20

Generate Check Code checkbox from Barcode Extended.

scComSAMLightClientCtrlLongDataIdBarcodeFlagInvertCellMode

0x40

Inverted Cellmode checkbox from Barcode Extended. "Cell mode" must be enabled and "invert" disabled.

scComSAMLightClientCtrlLongDataIdBarcodeFlagUseUtf8

0x800

UTF-8 Checkbox.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Enable "variable length" and "invert" of barcode "bc":

int CCI_Return = cci.ScSetEntityLongData( "bc", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdBarcodeSetFlags, ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdBarcodeFlagVariableLength | ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdBarcodeFlagInvert );

C# Example: Disable "invert" of barcode "bc":

int CCI_Return = cci.ScSetEntityLongData( "bc", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdBarcodeClearFlags, ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdBarcodeFlagInvert );

C# Example: Get barcode parameters of barcode "bc":

int Flag = cci.ScGetEntityLongData( "bc", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdBarcodeSetFlags );

DLL Function

int CCI_Return = ScSetEntityStringData(string Entity_Name, int Data_ID, string Barcode_Type)

int CCI_Return = ScGetEntityStringData(string Entity_Name, int Data_ID, ref string Barcode_Type)

ASCII Function

int CCI_Return = ScCciSetEntityStringData(string Entity_Name, int Data_ID, string Barcode_Type)

string Barcode_Type = ScCciGetEntityStringData(string Entity_Name, int Data_ID)

Description

Set or get the barcode type.

Entity_Name

Type: string

Unit: none

Specify the entity to be changed.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlStringDataIdSetBarcodeType

19

Set barcode type.

scComSAMLightClientCtrlStringDataIdGetBarcodeType

20

Get barcode type.

Barcode_Type

Type: string

Unit: none

Specify the barcode type.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Set barcode type of barcode "bc" to "DataMatrixEx":

int CCI_Return = cci.ScSetEntityStringData( "bc", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlStringDataIdSetBarcodeType, "DataMatrixEx" );

C# Example: Get barcode type of barcode "bc":

string Barcode_Type = "";

int CCI_Return = cci.ScGetEntityStringData( "bc", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlStringDataIdGetBarcodeType, ref Barcode_Type );

DLL Function

int CCI_Return = ScSetEntityLongData(string Entity_Name, int Data_ID, int HRT_State)

int HRT_State = ScGetEntityLongData(string Entity_Name, int Data_ID)

ASCII Function

int CCI_Return = ScCciSetEntityLongData(string Entity_Name, int Data_ID, int HRT_State)

int HRT_State = ScCciGetEntityLongData(string Entity_Name, int Data_ID)

Description

Set or get the human readable text state of a barcode entity.

Entity_Name

Type: string

Unit: none

Specify the entity name to be changed.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdDataBarcodeTextEnable

107

HRT_State

Type: int

Unit: none

•0: Disable human readable text.

•1: Enable human readable text.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Enable the human readable text for the barcode entity "bc":

int CCI_Return = cci.ScSetEntityLongData("bc", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataBarcodeTextEnable, 1);

C# Example: Get human readable text state of barcode "bc":

int HRT_State = cci.ScGetEntityLongData("bc", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataBarcodeTextEnable);

DLL Function

int CCI_Return = ScSetEntityDoubleData(string Entity_Name, int Data_ID, double Parameter)

int CCI_Return = ScGetEntityDoubleData(string Entity_Name, int Data_ID, ref double Parameter)

ASCII Function

int CCI_Return = ScCciSetEntityDoubleData(string Entity_Name, int Data_ID, double Parameter)

double Parameter = ScCciGetEntityDoubleData(string Entity_Name, int Data_ID)

Description

Set or get the current applied settings for human readable text for a barcode entity.

Entity_Name

Type: string

Unit: none

Specify the entity name.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlDoubleDataIdTextPointResolution

7

Change the resolution of the lines in percent. Not available for Simple Fonts. Unit: none.

scComSAMLightClientCtrlDoubleDataIdTextBaseline

8

Change the distance between the baseline of the barcode and the baseline of the text. Unit: mm.

Parameter

Type: double

Unit: depends on constant

The desired value.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Set text point resolution of barcode "bc" to 50%:

int CCI_Return = cci.ScSetEntityDoubleData("bc", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataTextPointResolution, 0.5);

C# Example: Get text point resolution of barcode "bc":

double Text_Point_Resolution = -1.0;

int CCI_Return = cci.ScGetEntityDoubleData("bc", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdDataTextPointResolution, ref Text_Point_Resolution);