DLL Function

int CCI_Return = ScSetIDStringData(int Data_ID, int Index, string Name)

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

ASCII Function

int CCI_Return = ScCciSetIDStringData(int Data_ID, int Index, string Name)

string Name = ScCciGetIDStringData(int Data_ID, int Index)

Description

This is used to set/get the name of an entity by its index or the current entity name. 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

scComSAMLightClientCtrlStringDataIdGetEntityName

21

If not deactivated with a mode flag this will get the name the of a sub-entity based on the index.

scComSAMLightClientCtrlStringDataIdSetEntityName

23

If not deactivated with a mode flag this will set the name of a sub-entity also (groups, etc.) based on the index. To change the name based on the current name use ScSetEntityStringData() or ScSetIDStringData().

Index

Type: int

Unit: none

Set or get the entity ID.

Name

Type: string

Unit: none

Set or get the entity name.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Set the name of the 0th entity to "newName":

int CCI_Return = cci.ScSetIDStringData((int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlStringDataIdSetEntityName, 0, "newName");

C# Example: Get the name of the 10th entity:
 
string Name = "";

int CCI_Return = cci.ScGetIDStringData((int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlStringDataIdGetEntityName, 10, ref Name);

DLL Function

int CCI_Return = ScSetStringValue(int Value_Type, string Group_Name)

ASCII Function

int CCI_Return = ScCciSetStringValue(int Value_Type, string Group_Name)

Description

Gives the grouped entities a name as string.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlStringValueTypeGroupingName

37

Group_Name

Type: string

Unit: none

The coresponding group name.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Set a group name:
 
int CCI_Return = cci.ScSetStringValue((int)ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlStringValueType, "Group_Name");

DLL Function

int CCI_Return = ScSetIDStringData(int Data_ID, int Index, string Name)

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

ASCII Function

int CCI_Return = ScCciSetIDStringData(int Data_ID, int Index, string Name)

string Name = ScCciGetIDStringData(int Data_ID, int Index)

Description

This value can be used to get the name of a top-level entity that is specified by a zero based index number starting from 0 to 65535 (lower 16 bits). Use GetEntityName when you want to iterate trough all levels.

Data_ID

Type: int

ID:

Location: ScComSAMLightClientCtrlFlags

scComSAMLightClientCtrlStringDataIdGetToplevelEntity

17

Get the name of a top level entity.

scComSAMLightClientCtrlStringDataIdSetToplevelEntity

25

Set the name of a top level entity.

Index

Type: int

Unit: none

The corresponding index of the entity.

Name

Type: string

Unit: none

The new name of the top-level entity.

CCI_Return

Type: int

CCI return number, see error list.

Notes

-

C# Example: Please refer to the Programming Examples: Retrieve Entities.

C# Example: Give the name to the very first top level entity:

int CCI_Return = cci.ScSetIDStringData((int)ScComSAMLightClientCtrlFlags.scComSAMLightClientCtrlStringDataIdSetToplevelEntity, 0, "NewName");