<< Click to Display Table of Contents > 

Client Control Interface Manual > Other > Retrieve Multiple Values

Retrieve Multiple Values
Previous pageReturn to chapter overviewNext page

Bulk Data

 

Bulk Data
 

Set

Get

DLL Function

int CCI_Return = ScSetStringValue(int Value_Type, string Bulk_Data)

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

ASCII Function

int CCI_Return = ScCciSetStringValue(int Value_Type, string Bulk_Data)

string Bulk_Data = ScCciGetStringValue(int Value_Type)

Description

Retrieve Multiple CCI values.

Value_Type

Type: int

ID:

Location: ScComSAMLightClientCtrlValueTypes

scComSAMLightClientCtrlStringValueTypeBulkData

43

Set: Set bulk data configuration, which defines which CCI values are retrieved by the get command. The bulk data configuration is a string consisting of multiple entries. An entry has the following structure: <Separator><Type><ID>

o<Separator>: Separator between bulk data. Can be any single character that is not used in <Type> or <ID>, but must remain the same for the entire bulk data configuration. It also determines the separator of the get command.

o<Type>: The value type of the CCI constant:

d: for Double Value Types

l: for Long Values Types

s: for String Value Types

o<ID>: ID of the CCI constant.

Get: Returns multiple CCI values as a string. The values and the separator are defined by the set command.

Bulk_Data

Type: string

Unit: none

Set: Bulk data configuration

Get: Bulk data

CCI_Return

Type: int

CCI error number, see error list.

Notes

There are maximum string lengths depending on the CCI implementation used.

C# Example: Set bulk data configuration to retrieve number of marks, override power and correction file name separated by semicolon. Get bulk data:

 

int CCI_Return_01 = cci.ScSetStringValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlStringValueTypeBulkData, ";l1;d2;s13" );

 

string Bulk_Data = "";

int CCI_Return_02 = cci.ScGetStringValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlStringValueTypeBulkData, ref Bulk_Data );

 

Example for Bulk_Data string:

"0;100.000000;C:\\scaps\\sam2d\\usc1\\cor_neutral.ucf"

Table 373: Bulk Data