DLL Function

int CCI_Return = ScExecCommand(int Cmd_ID)

ASCII Function

int CCI_Return = ScCciExecCommand(int Cmd_ID)

Description

Remove the current job and creates a new one with empty working area.

Cmd_ID

Type: int

ID:

Location:ScComSAMLightClientCtrlExecCommandConstants

scComSAMLightClientCtrlExecCommandNewJob

3

CCI_Return

Type: int

CCI return number, see error list.

Notes

•ScCciNewJob() is deprecated, please use this ExecCommand.

•The removed job file exists on last saving state.

C# Example: Create new job:

int CCI_Return = cci.ScExecCommand((int)ScComSAMLightClientCtrlExecCommandConstants.scComSAMLightClientCtrlExecCommandNewJob);

DLL Function

string CCI_Return = ScFlashCommand(string Command, int Flag, ref string FCI_Return)

ASCII Function

-

Description

Executes a command in the flash mode. Return is an empty string variable that you have to declare in advance.

Command

Type: string

Unit: none

The string Command is the flash command as you would type it in inside the flash dialog window and it has to be terminated by the ASCII characters 13 and 10 (Return and LineFeed). For the flash commands see the corresponding hardware manual.

Flag

Type: int

Unit: none

Flags can be 0 or -2147483648. If 0, the client control waits until a carriage return from the Flash. If -2147483648 is set the client control will wait a certain time and then end the command.

FCI_Return

Type: string

Unit: none

Standard Flash error codes.

CCI_Return

Type: string

The CCI_Return is a string and not an integer as usual.

CCI return number, see error list.

Notes

•Some of the commands require the flash license. Further information is given in the Flash command interface documentation.

C# Example: Start marking:
 
string FCI_Return = "";

string CCI_Return = cci.ScFlashCommand("M 1\r\n", 0, ref FCI_Return);

DLL Function

int CCI_Return = ScExport(string Entity_Name, string File_Name, string File_Type, double Resolution, int Flag)

ASCII Function

-

Description

Exports the job file or the specified entity to File_Name.

Entity_Name

Type: string

Unit: none

If Entity_Name is "" then the whole job is exported.

File_Name

Type: string

Unit: none

The full path where the exported job should be saved to.

File_Type

Type: string

Unit: none

Can be "saf", "plt" or "cnc".

Resolution

Type: double

Unit: none

Resolution only has an impact if the File_Type is "plt".

Flag

Type: int

Flag:

Location: None

scComLayerFile2DStyleExportPolyLines

0x10

The poly lines will be exported.

scComLayerFile2DStyleExportLineArrays

0x20

The line arrays will be exported.

scComLayerFile2DStyleWritePens

0x100

The pens will be exported.

scComLayerFile2DStyleExportOnlySelected

0x400

Only the entities selected in the View will be exported.

scComLayerFile2DStyleWritePreview

0x2000

The job preview will be exported.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•This Flags value is usually a combination of multiple flags. Be sure not to accidentally overwrite the previous flags. See the chapter How to work with flags to learn more about combining multiple flags.

•When using this command in SAM3D, the last two arguments (Resolution and Flags) have to be 0. Exports the layer styles table of the ScLayerSolid entity specified with Entity_Name to the *.txt file FileName. Please use 'style' as Type. Exports the slices with Entity type ScLayerSolid to a specified path with fileName.cli and format *cli. Only one ScLayerSolid can be exported at a time.

C# Example: Export the whole job including pen settings and poly lines:
 
string FileName = "C:/Users/Support/Desktop/ExportJob.plt";

int flags = 0X10;

flags |= 0x100;

int CCI_Return = cci.ScExport("", FileName, "plt", 0.001, flags);

DLL Function

int CCI_Return = ScProcessFlashJob(string File_Name, int Job_Num, int Mode, int Flag)

ASCII Function

int CCI_Return = ScCciProcessFlashJob(string File_Name, int Job_Num, int Mode, int Flag)

Description

This command allows you to access the flash jobs, see Flash Jobs and Settings. Flag must be 0.

File_Name

Type: string

Unit: none

Defines the complete path to the UNF file.

Job_Num

Type: int

Unit: none

Defines the Flash Job Number.

Mode

Type: int

Index:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlProcessFlashJobModeStoreCurrentToFlash

1

For standalone mode, the Flash job (UNF) is created from the SAMLight job (SJF)

together with a subset of the SAMLight settings and is saved on the USC card and in

<SCAPS>\jobfiles. This means, the creation of the identical UNF from the SJF always

requires identical SAMLight settings. Furthermore, a copy of the SJF is also stored on

the USC card. This mode of ScProcessFlashJob is only possible if the SJF already

exists.

•Job_Num defines the flash job number. File_Name and Flags are not used.

scComSAMLightClientCtrlProcessFlashJobModeLoadFromFlash

2

Loads the copy of the SJF job (which is stored on the USC) to SAMLight. Job_Num defines the flash job number. However, the USC settings and the UNF cannot be loaded to SAMLight.

•Please note: Different SAMLight settings in combination with the same SJF will lead to different UNFs.

•File_Name and Flags are not used.

scComSAMLightClientCtrlProcessFlashJobModeStoreFromDiskToFlash

3

Saves a job (*.unf or *.cnc) from hard disc (PC) to the USC flash.

•Job_Num defines the flash job number.

•File_Name defines the complete path to the UNF file.

•Flags are not used.

scComSAMLightClientCtrlProcessFlashJobModeLoadFromFlashToDisk

5

Saves a job (*.unf) from the USC flash to hard disc (PC).

•Job_Num defines the flash job number.

•File_Name defines the complete path to the UNF file.

•Flags are not used.

Flag

Type: int

Unit: none

•0: Flag must be 0.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•An Index can not be combined.

C# Example: Save the job to the USC flash memory:

int CCI_Return = cci.ScProcessFlashJob( @"F:\job.unf", 2, ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlProcessFlashJobModeStoreFromDiskToFlash, 0 );

DLL Function

int CCI_Return = ScImport(string Entity_Name, string File_Name, string File_Type, double Resolution, int Flag)

ASCII Function

int CCI_Return = ScCciImport(string Entity_Name, string File_Name, string File_Type, double Resolution, int Flag)

Description

Imports a file from the path File_Name.

Entity_Name

Type: string

Unit: none

The name of the new entity.

File_Name

Type: string

Unit: none

The full path to the file to import.

File_Type

Type: string

Unit: none

•File_Type can be "ai", "bmp", "cli" "cmx", "cnc", "dxf_scaps", "dxf_old", "emf", "gif", "jpg", "mcl", "pcx", "plt", "png", "saf", "slc", "stl", "style", "svg_scaps", "svg_old", "tga", "tif", "twain" or "txt".

•With "style" a layer styles table can be imported. In this case Entity_Name specifies which ScLayerSolid entity you want to assign to this style table and File_Name has to be a file path to a *.txt file.

Resolution

Type: double

Unit: mm

Resolution only has an impact if the File_Type is "plt".

Flag

Type: int

Flag:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlImportFlagKeepOrder

0x8

Keep the order of the entities.

scComSAMLightClientCtrlImportFlagReadPenInfo

0x80

Read pen information.

scComSAMLightClientCtrlImportFlagUnitlessIsMM

0x100

It is only used for the "svg_scaps" File_Type. If enabled, unitless coordinates and coordinates in 'px' are converted to mm with 25.4 dpi ('px' equals 'mm') instead of 96 dpi.

scComSAMLightClientCtrlImportFlagGcodeLoadPenParameters

0x2000

ScSetHead before. See Import Advanced for CNC.

scComSAMLightClientCtrlImportFlagGcodeLoadOpticParameters

scComSAMLightClientCtrlImportFlagPointCloud

0x4000

•GcodeLoadOpticParameters (File_Type "cnc" only): Load optic parameters of a CNC file to the head specified with ScSetHead before. See Import Advanced for CNC.

•PointCloud (File_Type "plt" only): Import of points into PointClouds.

scComSAMLightClientCtrlImportFlagRememberCenterPosition

0x8000

Keep center position when importing vectors. VectorReimport flag is required.

scComSAMLightClientCtrlImportFlagNotTryToClose

0x20000

Do not try to close polygons. This option applies to HPGL type files only.

scComSAMLightClientCtrlImportFlagOptimized

0x80000

Only for HPGL files: Will do the same as the checkbox in the import dialog: Closing

Polylines which end close to each other and delete double ones or ones that are very

short.

scComSAMLightClientCtrlImportFlagBitmapReimport

0x100000

Reimports a Bitmap with Entity_Name. If the position should be kept, the Bitmap has to be a scanner bitmap and the position has to be enabled and set in the bitmap extended dialogue. In this case the center coordinates can be defined.

scComSAMLightClientCtrlImportFlagDontUpdateView

0x200000

Do not update view when importing. This can be used to import several files quickly and update the view manually after the last import has been done.

scComSAMLightClientCtrlImportFlagSetParamDouble

0x400000

Sets the spline resolution: scComSAMLightClientCtrlDoubleValueTypeDoublePara1 = 1 (for dxf spline resolution) and scComSAMLightClientCtrlDoubleValueTypeDoublePara1 (resolution in %, min. 10; max.100) to be defined before the import.

scComSAMLightClientCtrlImportFlagVectorReimport

0x800000

Reimports Vector Graphics like DXF and PLT with Entity_Name. EntityLevel and assigned pen are preserved, position and sizes must be reset.

scComSAMLightClientCtrlImportFlagToplevelOnly

0x1000000

Reimports only entities in the first level of the job.

scComSAMLightClientCtrlImportFlagFillWithDefaultHatchStyle

0x2000000

Only for SVG files. Will do the same as the checkbox in the import dialog: Hatch filled objects with the default hatch.

scComSAMLightClientCtrlImportFlagNoErrorMsg

0x4000000

Suppresses Error Messages.

scComSAMLightClientCtrlImportFlagCreateOneGroup

0x8000000

Automatically do Data Wizard --> Create One Group.

scComSAMLightClientCtrlImportFlagCenterToField

0x10000000

Center the import in the View2D.

scComSAMLightClientCtrlImportFlagImportToPenGroups

0x20000000

Will do the same as the checkbox in the import dialog.

scComSAMLightClientCtrlImportFlagUsePenColors

0x40000000

Will do the same as the checkbox in the import dialog. This should be used with command 128.

scComSAMLightClientCtrlImportFlagProtected

0x80000000

Polyline and LineArray entities imported with this flag will not be shown in the View2D and will not be split. Vectors of entities imported with this flag will not be stored in a *.sjf file. However, it is possible to remember the last position of the protected entities within the *.sjf file. If you re-import an entity with the same name, the old position will be adjusted automatically. Protected entities can be rotated and translated but not scaled. The red pointer pre-view will only show the outline of protected entities. Pen and hatch properties of protected entities cannot be changed. If at least one protected entity is present within the entity list the mark preview is not possible any more. They cannot be copied, duplicated or grouped.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•This Flags value is usually a combination of multiple flags. Be sure not to accidentally overwrite the previous flags. See the chapter How to work with flags to learn more about combining multiple flags.

•When using this command in SAM3D, the last two arguments (Resolution and Flags) have to be 0.

C# Example: Reimport a bitmap file:

int CCI_Return = cci.ScImport( "BackgroundImage", @"F:\TestBitmap.bmp", "bmp", 1, ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlImportFlagBitmapReimport );

DLL Function

void ScSetData(int Type, string Entity_Name, ref byte Data_First_Byte, uint Data_Size, string File_Type, double Resolution, int Flags)

ASCII Function

-

Description

Imports a file from memory via COM (CCI Ex).

Type

Type: int

Unit: none

•0: Type must be 0.

Entity_Name

Type: string

Unit: none

see ScImport()

Data_First_Byte

Type: byte

Unit: none

Reference to the first byte of the data array.

Data_Size

Type: uint

Unit: bytes

Number of bytes of data.

File_Name

Type: string

Unit: none

see Import File (ScImport)

File_Type

Type: string

Unit: none

see Import File (ScImport)

Resolution

Type: double

Unit: mm

see Import File (ScImport)

Flag

Type: int

Flag:

see Import File (ScImport)

CCI_Return

Type: int

CCI return number, see error list.

Notes

•Import from Memory can only be used via Function Calls (no ASCII, no TCP).

•There is a separate function for Import from Memory via OCX (ActiveX).

•see Import File (ScImport) for further notes.

C# Example: Import a PLT file from memory via COM (CCI Ex):

string plt_path = @"F:\Columbia.plt";

System.IO.File.OpenRead( plt_path );

System.Byte[] Data = System.IO.File.ReadAllBytes( plt_path );

int Flags =

   ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlImportFlagReadPenInfo |

   ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlImportFlagUsePenColors;

cci.ScSetData( 0, "plt Columbia", ref Data[ 0 ], ( uint )Data.GetLength( 0 ), "plt", 0.01, Flags );

DLL Function

int CCI_Return = ScSetData(int Type, string Entity_Name, byte[] Data, string File_Type, double Resolution, int Flags)

ASCII Function

-

Description

Imports a file from memory via OCX (ActiveX).

Type

Type: int

Unit: none

•0: Type must be 0.

Entity_Name

Type: string

Unit: none

see Import File (ScImport)

Data

Type: byte[]

Unit: none

Byte array that represents the data.

File_Name

Type: string

Unit: none

see Import File (ScImport)

File_Type

Type: string

Unit: none

see Import File (ScImport)

Resolution

Type: double

Unit: mm

see Import File (ScImport)

Flag

Type: int

Flag:

see Import File (ScImport)

CCI_Return

Type: int

CCI return number, see error list.

Notes

•Import from Memory can only be used via Function Calls (no ASCII, no TCP).

•There is a separate function for Import from Memory via COM (CCI Ex).

•see Import File (ScImport) for further notes.

C# Example: Import a PLT file from memory via OCX (ActiveX):

string plt_path = @"F:\Columbia.plt";

System.IO.File.OpenRead( plt_path );

System.Byte[] Data = System.IO.File.ReadAllBytes( plt_path );

int Flags =

   ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlImportFlagReadPenInfo |

   ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlImportFlagUsePenColors;

cci.ScSetData(0, "plt Columbia", Data, "plt", 0.01, Flags );

DLL Function

int CCI_Return = ScGetStringValue(int Value_Type, ref string Job_Path)

ASCII Function

string Job_Path = ScCciGetStringValue(int Value_Type)

Description

Get the name of the current job file with its complete path.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlStringValueTypeJobFileName

4

Job_Path

Type: string

Returns the name of the current job file with its complete path.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Get job file name and path:

string Job_Path = "";

int CCI_Return = cci.ScGetStringValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlStringValueTypeJobFileName, ref Job_Path);

DLL Function

int CCI_Return = ScGetPreviewImage(string Job_File_Path, string Bitmap_File_Path)

ASCII Function

int CCI_Return = ScCciGetPreviewImage(string Job_File_Path, string Bitmap_File_Path)

Description

Get a preview bitmap image of a *.sjf job file and save it to the local hard disc. The size of the resulting bitmap is 100 x 100 pixel.

Job_File_Path

Type: string

Unit: none

Enter the complete job path here

Bitmap_File_Name

Type: string

Unit: none

Enter the complete path, where you want to store the bitmap preview image

CCI_Return

Type: int

CCI return number, see error list.

Notes

•The job will not be load into SAMLight during the generation of the bmp.

C# Example: Save a preview bitmap of the job F:\circle.sjf to F:\circle.bmp:

int CCI_Return = cci.ScGetPreviewImage( @"F:\circle.sjf", @"F:\circle.bmp" );

DLL Function

int Is_In_Field = ScExecCommand(int Cmd_ID)

ASCII Function

int Is_In_Field = ScCciExecCommand(int Cmd_ID)

Description

Check, if the job is inside the Working Field.

Cmd_ID

Type: int

ID:

Location:ScComSAMLightClientCtrlExecCommandConstants

scComSAMLightClientCtrlExecCommandCheckIfJobIsInField

40

Is_In_Field

Type: int

•0: Job is not inside the field.

•1: Job is inside the field.

Notes

-

C# Example: Check if job in field:

int is_In_Field = cci.ScExecCommand( ( int )ScComSAMLightClientCtrlExecCommandConstants.scComSAMLightClientCtrlExecCommandCheckIfJobIsInField );

DLL Function

int CCI_Return = ScLoadJob(string File_Name, int Load_Entities, int Overwrite_Entities, int Load_Materials)

ASCII Function

int CCI_Return = ScCciLoadJob(string File_Name, int Load_Entities, int Overwrite_Entities, int Load_Materials)

Description

Loads the SJF or S3D job file specified by File_Name into the controlled scanner application. A SJF job file can contain graphical data (entities) and / or scanner and laser parameters (materials).

File_Name

Type: string

Unit: none

Enter the full path of the job file

Load_Entities

Type: int

Unit: none

If the parameter Load_Entities is set to 1, the entities contained in the job will be loaded.

Overwrite_Entities

Type: int

Unit: none

If the parameter Overwrite_Entities is set to 1, the current job will be cleared before the new one is loaded. If Overwrite_Entities is set to 0, it is possible to merge the graphical information of different jobs. For S3D job files only the Overwrite_Entities parameter is valid to control if the jobs have to be merged 0 or not 1. The parameters Load_Entities and Load_Materials are ignored.

Load_Materials

Type: int

Unit: none

If the parameter Load_Materials is set to 1, the scanner parameters will be loaded with the job.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•All three parameters have to be defined, when executing this command.

•With the additional parameters it is possible to load

oonly the graphical data (Load_Entities=1, Load_Materials=0)

oonly the scanner parameters (Load_Entities=0, LoadMaterials=1)

oboth (Load_Entities=1, Load_Materials=1).

•If you want to load a*.s3d file set all int parameters equal to 1.

C# Example: Load the job, overwriting existing entities and loading all the materials:

string FileName = "C:/Users/Support/Desktop/CircleJob.sjf";

int CCI_Return = cci.ScLoadJob(FileName, 1, 1, 1);

DLL Function

int CCI_Return = ScSetLongValue(int Value_Type, int Flag)

int Flag = ScGetLongValue(int Value_Type)

ASCII Function

int CCI_Return = ScCciSetLongValue(int Value_Type, int Flag)

int Flag = ScCciGetLongValue(int Value_Type)

Description

Set or get the flags, allowing to lock a SJF job file to specific dongles.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlLongValueTypeSetLockSjfToDongleFlags

66

Flag

Type: int

Flag:

Location: None

scComSAMLightClientCtrlLockToDongleFlagLockLoadToSystemId

0x1

Locks the SJF job file to the Dongle ID (System ID, Card ID).

scComSAMLightClientCtrlLockToDongleFlagLockLoadToUserId

0x2

Locks the SJF job file to the Customer ID (User ID).

scComSAMLightClientCtrlLockToDongleFlagLockExport

0x4

Locks the export function of the SJF job file.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Lock the job file to the customer ID:
 
int CCI_Return = cci.ScSetLongValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeSetLockSjfToDongleFlags, 2);

C# Example: Get set flags:
 
int Flag = cci.ScGetLongValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeSetLockSjfToDongleFlags);

DLL Function

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

ASCII Function

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

Description

Move the chosen entity before or after the chosen reference entity within the entity list.

Entity_Name

Type: string

Unit: none

Specify the entity to be moved.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlStringDataIdMoveEntityBefore

37

Move entity before chosen reference entity.

scComSAMLightClientCtrlStringDataIdMoveEntityAfter

38

Move entity after chosen reference entity.

Ref_Entity

Type: string

Unit: none

Specify the reference entity.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•Each entity must have a name.

•Do not use entity names twice.

C# Example: Move Entity "C" before Entity "A" within the entity list:

int CCI_Return = cci.ScSetEntityStringData("C", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlStringDataIdMoveEntityBefore , "A");

DLL Function

int CCI_Return = ScSaveJob(string File_Name, int Flag)

ASCII Function

int CCI_Return = ScCciSaveJob(string File_Name, int Flag)

Description

Save the current job file.

File_Name

Type: string

Unit: none

The full path where the job file should be stored.

Flag

Type: int

Flag:

Location: None

scComSAMLightSaveFlagEntities

0x1

Saves the entities to the job file.

scComSAMLightSaveFlagMaterials

0x2

Saves the pens to the job file.

scComSAMLightSaveFlagUseCurrentJobName

0x4

Uses the current job file name of the scanner application. The parameter FileName will be ignored in this case.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•This Flags value is usually a combination of multiple flags. Be sure not to accidentally overwrite the previous flags. See the chapter How to work with flags to learn more about combining multiple flags.

C# Example: Save the job with the Entities and keeping the current job name:

int flags = 0X1;

flags |= 0X4;

int CCI_Return = cci.ScSaveJob("",flags);

DLL Function

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

int Is_Selected = ScGetEntityLongData(string Entity_Name, int Data_ID)

ASCII Function

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

int Is_Selected = ScCciGetEntityLongData(string Entity_Name, int Data_ID)

Description

This function can be used to set or get the selection state of entities or to get information whether the entity is selected.

Entity_Name

Type: string

Unit: none

Specify the entity to be changed.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdEntitySelected

3

Is_Selected

Type: int

Unit: none

•0: Deselect.

•1: Select.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Select the entity "square1":

int CCI_Return = cci.ScSetEntityLongData("square1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntitySelected, 1);

C# Example: Check, if the entity "circle1" is selected:

int is_Selected = cci.ScGetEntityLongData("circle1", (int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntitySelected);

DLL Function

int CCI_Return = ScExecCommand(int Cmd_ID)

ASCII Function

int CCI_Return = ScCciExecCommand(int Cmd_ID)

Description

Sorts objects inside a group by their name if the name of the group is specified with Top Level. If no group name is specified this sorts the top level entities of the job.

Cmd_ID

Type: int

ID:

Location:ScComSAMLightClientCtrlExecCommandConstants

scComSAMLightClientCtrlExecCommandSortJobByName

52

CCI_Return

Type: int

CCI return number, see error list.

Notes

•A entity can be set as top level with the following command SetToTopLevelEntity.

C# Example: Sort entity by name:

int CCI_Return = cci.ScExecCommand((int)ScComSAMLightClientCtrlExecCommandConstants.scComSAMLightClientCtrlExecCommandSortJobByName);

DLL Function

int CCI_Return = ScExecCommand(int Cmd_ID)

ASCII Function

int CCI_Return = ScCciExecCommand(int Cmd_ID)

Description

Executes the UNDO command.

Value_Type

Type: int

ID:

Location:ScComSAMLightClientCtrlExecCommandConstants

scComSAMLightClientCtrlExecCommandUndo

54

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Execute UNDO:

int CCI_Return = cci.ScExecCommand((int)ScComSAMLightClientCtrlExecCommandConstants.scComSAMLightClientCtrlExecCommandUndo);

DLL Function

int CCI_Return = ScSetDoubleValue(int Value_Type, double User_Value)

double User_Value = ScSetGoubleValue(int Value_Type)

ASCII Function

int CCI_Return = ScCciSetDoubleValue(int Value_Type, double User_Value)

double User_Value = ScCciGetDoubleValue(int Value_Type)

Description

Set or get a double value into an unused and hidden entity in the job. This entity will be generated automatically unless it is already existing.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlDoubleValueTypeUserValue

20000-20015

User_Value

Type: double

Unit: none

The value you want to set or get.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•The values from 20001 to 20015 can be used with the same functionality.

C# Example: Set the 20002'nd double user value to 100.0:

int CCI_Return = cci.ScSetDoubleValue(20002, 100.0)

C# Example: Read the content of the 20002'nd double user value:
 
double User_20002 = cci.ScGetDoubleValue(20002);

DLL Function

int CCI_Return = ScSetStringValue(int Value_Type, string User_Value)

int CCI_Return = ScGetStringValue(int Value_Type, ref string User_Value)

ASCII Function

int CCI_Return = ScCciSetEntityStringValue(int Value_Type, string User_Value)

string User_Value = ScCciGetEntityStringValue(int Value_Type)

Description

Set or get a string value into an unused and hidden entity in the job. This entity will be generated automatically unless it is already existing. The values from 20001 to 20009 can be used with the same functionality.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlStringValueTypeUserValue

20000-20009

User_Value

Type: int

Unit: none

The value you want to set or get.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•The values from 20001 to 20009 can be used with the same functionality.

C# Example: Save some random string to the 20003'rd user value:

string random_Information = "Some random string";

int CCI_Return = cci.ScSetStringValue(20003, random_Information);

C# Example: Read the content of the 20003'rd user value:
 
string user_20003_string = "";

int CCI_Return = cci.ScGetStringValue(20003, ref user_20003_string);