DLL Function

int CCI_Return = ScSetLongValue(int Value_Type, int SN_In_Job)

int SN_In_Job = ScGetLongValue(int Value_Type)

ASCII Function

int CCI_Return = ScCciSetLongValue(int Value_Type, int SN_In_Job)

int SN_In_Job = ScCciGetLongValue(int Value_Type)

Description

Set or get the state of the "enable" checkbox under "All Serial Numbers in Job" on entity property page.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlLongValueTypeEnableAllSerialNumbersInJob

95

SN_In_Job

Type: int

Unit: none

•0: Disable.

•1: Enable.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Enable all serial numbers in the job:

int CCI_Return = cci.ScSetLongValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeEnableAllSerialNumbersInJob, 1);

C# Example: Check the status of the checkbox:

int checkbox = cci.ScGetLongValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeEnableAllSerialNumbersInJob);

DLL Function

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

ASCII Function

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

Description

This is used to change the file name of a serial number list in txt/xlsx format. This is recommended to use with ResetSerialNumber together.

Entity_Name

Type: string

Unit: none

Specify the entity to be changed.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlStringDataIdEntitySerialASCIIFileName or

scComSAMLightClientCtrlStringDataIdEntitySerialExcelFileName

24

Name

Type: string

Unit: none

Enter the new path.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•The "from File" checkbox has to be activated before.

•You can insert an existing path. No new files will be created with this command.

C# Example: Change the serial numbers file path to the file "serial2.txt" (for the entity "SerialEntity1"):
 
string new_Name = "C:/Users/Support/serial2.txt";

int CCI_Return = cci.ScSetEntityStringData("SerialEntity1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlStringDataIdEntitySerialASCIIFileName, newName);

DLL Function

-

ASCII Function

int CCI_Return = ScCciDecSerialNumbers()

Description

This call decrement all serial number entities.

CCI_Return

Type: int

CCI return number, see Error list.

Notes

-

C# Example: -

DLL Function

-

ASCII Function

int CCI_Return = ScCciIncSerialNumbers()

Description

This call increments all serial number entities.

CCI_Return

Type: int

CCI return number, see Error list.

Notes

-

C# Example: -

DLL Function

-

ASCII Function

int CCI_Return = ScCciResetSerialNumbers()

Description

This call resets all serial number entities to their start values.

CCI_Return

Type: int

CCI return number, see Error list.

Notes

•Further command to reset via DLL function is given in Entities->Objects->SerialNumber

C# Example: -

DLL Function

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

int SN_Flags = ScGetEntityLongData(string Entity_Name, int Data_ID)

ASCII Function

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

int SN_Flags = ScCciGetEntityLongData(string Entity_Name, int Data_ID)

Description

Change the type of the serial number input.

Entity_Name

Type: string

Unit: none

Specify the entity to be changed.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdEntitySerialNumModesFlags

117

SN_Flags

Type: int

Flag:

Location: None

Text

0x1

BarCode

0x2

ASCIIFile

0x4

DateTime

0x8

CustomFormat

0x10

CCI_Return

Type: int

CCI return number, see error list.

Notes

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

•Text or BarCode is always required.

•Text and BarCode are incompatible with each other.

•ASCIIFile and CustomFormat are incompatible with each other.

•DateTime is incompatible with ASCIIFile and CustomFormat.

C# Example: Enable CustomFormat and don't change all other flags:

int SN_Flags = cci.ScGetEntityLongData( "SerialEntity1", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntitySerialNumModesFlags );

SN_Flags = SN_Flags | 0x10;

int CCI_Return = cci.ScSetEntityLongData( "SerialEntity1", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntitySerialNumModesFlags, SN_Flags );

C# Example: Disable CustomFormat and don't change all other flags:

int SN_Flags = cci.ScGetEntityLongData( "SerialEntity1", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntitySerialNumModesFlags );

SN_Flags = SN_Flags & ~0x10;

int CCI_Return = cci.ScSetEntityLongData( "SerialEntity1", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntitySerialNumModesFlags, SN_Flags );

C# Example: Enable Barcode, disable Text and don't change all other flags:

int SN_Flags = cci.ScGetEntityLongData( "SerialEntity1", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntitySerialNumModesFlags );

SN_Flags = (SN_Flags | 0x2) & ~0x1;

int CCI_Return = cci.ScSetEntityLongData( "SerialEntity1", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntitySerialNumModesFlags, SN_Flags );

DLL Function

int CCI_Return = ScExecCommand(int Cmd_ID)

ASCII Function

int CCI_Return = ScCciExecCommand(int Cmd_ID)

Description

Increment, decrement or reset all serial number entities in the job.

Cmd_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlExecCommandConstants

scComSAMLightClientCtrlExecCommandResetSerialNumber

8

Reset all the serial numbers in the job.

scComSAMLightClientCtrlExecCommandIncSerialNumber

23

Increment all serial numbers.

scComSAMLightClientCtrlExecCommandDecSerialNumber

24

Decrement all serial numbers.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Reset all serial numbers:
 
int CCI_Return = cci.ScExecCommand((int)ScComSAMLightClientCtrlExecCommandConstants.scComSAMLightClientCtrlExecCommandResetSerialNumber);

C# Example: Increment all serial numbers in the job:
 
int CCI_Return = cci.ScExecCommand((int)ScComSAMLightClientCtrlExecCommandConstants.scComSAMLightClientCtrlExecCommandIncSerialNumber);

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

Change different serial number parameters for the defined entity.

Entity_Name

Type: string

Unit: none

Specify the entity to be changed.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdEntitySerialStartValue

71

Get or set the start value of a serial number.

scComSAMLightClientCtrlLongDataIdEntitySerialIncrValue

72

Get or set the increment value for a serial number object.

scComSAMLightClientCtrlLongDataIdEntitySerialCurrValue

73

Get the current value of a serial number.

scComSAMLightClientCtrlLongDataIdEntitySerialNumLines

77

Set the number of lines to be read from an ASCII file. Default is 1.

scComSAMLightClientCtrlLongDataIdEntitySerialBeatCount

79

Get or set the beat count of the serial number.

scComSAMLightClientCtrlLongDataIdEntitySerialResetCount

80

Get or set the reset count of the serial number.

Parameter

Type: int

Unit: none

The corresponding value.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•The new values are used, after a serial number is reset by using ResetSerialNumber.

C# Example: Change the start value for the entity "SerialEntity1" to 10:
 
//first set the new Start Value

int CCI_Return_01 = cci.ScSetEntityLongData("SerialEntity1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntitySerialStartValue, 10);

//reset all the serial numbers to update the start values

int CCI_Return_02 = cci.ScExecCommand((int)ScComSAMLightClientCtrlExecCommandConstants.scComSAMLightClientCtrlExecCommandResetSerialNumber);

C# Example: Get the current increment value for the entity "SerialEntity2":
 
int serial_2_Inc = cci.ScGetEntityLongData("SerialEntity2", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntitySerialIncrValue);