DLL Function

int CCI_Return = ScGetIDStringData(int Data_ID, int Index, ref string Parameter)

ASCII Function

string Parameter = ScCciGetIDStringData(int Data_ID, int Index)

Description

This is used to get the entity type by its index. The index is zero based and starts from the top level going through the tree on the base of the first object, going on with the siblings.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlStringDataIdGetEntityType

22

Get the entity type of a (sub)-entity based on its index.

scComSAMLightClientCtrlStringDataIdGetEntityTypeAsInSAMLight

35

Get the entity type as in SAMLight of a (sub)-entity based on its index.

Index

Type: int

Unit: none

The entity ID.

Parameter

Type: string

Unit: none

The entity type.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•Together with the top-level only mode flag it is possible just to get the type of the top-level entities. See example Retrieve entities.

C# Example: Get the entity type:

string entity_type = "";

int CCI_Return = cci.ScGetIDStringData((int) ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlStringDataIdGetEntityType, 0, ref entity_type);

C# Example: Get the entity type as in SAMLight of the second (sub)-entity:

 
string entity_type_as_in_SAMLight = "";

int CCI_Return_01 = cci.ScSetMode(0);

int CCI_Return_02 = cci.ScGetIDStringData((int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlStringDataIdGetEntityTypeAsInSAMLight, 1, ref entity_type_as_in_SAMLight);

DLL Function

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

int Checkbox = ScGetEntityLongData(string Entity_Name, int Data_ID)

ASCII Function

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

int Checkbox = ScCciGetEntityLongData(string Entity_Name, int Data_ID)

Description

Set or get the corresponding group checkboxes.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdEntityGroupPenPaths

118

Use this flag to get or set the checkbox PenPaths.

scComSAMLightClientCtrlLongDataIdEntityGroupCluster

119

Use this flag to get or set the checkbox Cluster.

Entity_Name

Type: string

Unit: none

Enter the name of the entity, which should be changed.

Checkbox

Type: int

Unit: none

•Enable checkbox PenPaths.

•Disable checkbox PenPaths.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•For to set group checkbox just the values 1 and 0 are valid.

C# Example: Set the group PenPath checkbox flag of an entity with entity name "grouped entities":

 
int CCI_Return = cci.ScSetEntityLongData("grouped entities", (int) ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntityGroupPenPaths, 1);

C# Example: Get the group PenPath checkbox flag of an entity with entity name "grouped entities":

int Proup_Pen_Paths = cci.ScGetEntityLongData("grouped entities", (int) ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntityGroupPenPaths);

DLL Function

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

int Mark_Beat_Count = ScGetEntityLongData(string Entity_Name, int Data_ID)

ASCII Function

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

int Mark_Beat_Count = ScCciGetEntityLongData(string Entity_Name, int Data_ID)

Description

Set or get the corresponding mark beat count.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdEntityMarkBeatCount

56

Entity_Name

Type: string

Unit: none

Enter the name of the entity, which should be changed.

Mark_Beat_Count

Type: int

Unit: none

The number of the mark beat count.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Set the mark beat count of an entity with entity name "rectangle" to 2:

 
int CCI_Return = cci.ScSetEntityLongData("rectangle", (int) ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntityMarkBeatCount, 2);

C# Example: Get the mark beat count of an entity with entity name "rectangle":

int Mark_Beat_Count = cci.ScGetEntityLongData("rectangle", (int) ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntityMarkBeatCount);

DLL Function

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

int Mark_Loop_Count = ScGetEntityLongData(string Entity_Name, int Data_ID)

ASCII Function

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

int Mark_Loop_Count = ScCciGetEntityLongData(string Entity_Name, int Data_ID)

Description

Set or get the corresponding mark loop count.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdEntityMarkLoopCount

55

Entity_Name

Type: string

Unit: none

Enter the name of the entity, which should be changed.

Mark_Loop_Count

Type: int

Unit: none

The number of the mark loop count.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Set the mark loop count of an entity with entity name "rectangle" to 10:

 
int CCI_Return = cci.ScSetEntityLongData("rectangle", (int) ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntityMarkLoopCount, 10);

C# Example: Get the Mark Loop Count of an entity with entity name "rectangle":

int Mark_Loop_Count = cci.ScGetEntityLongData("rectangle", (int) ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntityMarkLoopCount);

DLL Function

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

int Mark_Start_Count = ScGetEntityLongData(string Entity_Name, int Data_ID)

ASCII Function

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

int Mark_Start_Count = ScCciGetEntityLongData(string Entity_Name, int Data_ID)

Description

Set or get the mark start count, which corresponds to the mark beat offset.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdEntityMarkStartCount

57

Entity_Name

Type: string

Unit: none

Enter the name of the entity, which should be changed.

Mark_Start_Count

Type: int

Unit: none

the number of the Mark Start Count.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Set the mark start count of an entity with entity name "rectangle" to 1:

 
int CCI_Return = cci.ScSetEntityLongData("rectangle", (int) ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntityMarkStartCount, 1);

C# Example: Get the mark start count of an entity with entity name "rectangle":

int Mark_Start_Count = cci.ScGetEntityLongData("rectangle", (int) ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntityMarkStartCount);

DLL Function

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

int Mark_Flag = ScGetEntityLongData(string Entity_Name, int Data_ID)

ASCII Function

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

int Mark_Flag = ScCciGetEntityLongData(string Entity_Name, int Data_ID)

Description

Set or get the mark flags for mark contour and mark hatch of entity Entity_Name. The corresponding flag value is a bit field.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdEntityMarkFlags

58

Flag

Type: int

Flag:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdEntityMarkFlagMarkContour

0x1

Mark Contour.

scComSAMLightClientCtrlLongDataIdEntityMarkFlagMarkHatch

0x2

Mark Hatch.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•The mark hatch flag can only be set if the corresponding entity is hatched.

C# Example: Enable mark contour for an entity named "Circle":

int CCI_Return = cci.ScSetEntityLongData( "Circle", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntityMarkFlags, ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdMarkFlagmarkContour );

C# Example: Get the mark flags of an entity with entity name "Circle":

int Mark_Flags = cci.ScGetEntityLongData( "Circle", ( int )ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntityMarkFlags );

DLL Function

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

int As_Bitmap = ScGetEntityLongData(string Entity_Name, int Data_ID)

ASCII Function

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

int As_Bitmap = ScCciGetEntityLongData(string Entity_Name, int Data_ID)

Description

Set or get the corresponding As Bitmap checkbox.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlLongDataIdEntityOutputAsBitmap

121

Entity_Name

Type: string

Unit: none

Enter the name of the entity, which should be changed.

As_Bitmap

Type: int

Unit: none

•Enable checkbox As Bitmap.

•Disable checkbox As Bitmap.

CCI_Return

Type: int

CCI return number, see error list.

Notes

•For the checkbox just the values 1 and 0 are valid.

C# Example: Set the As Bitmap checkbox flag of an entity:

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

C# Example: Get the As Bitmap checkbox flag of an entity:

int As_Bitmap = cci.ScGetEntityLongData("", (int) ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlLongDataIdEntityOutputAsBitmap);