<< Click to Display Table of Contents > Mark Counter |
|
☐ Set ☒ Get |
||
---|---|---|---|
DLL Function |
int Mark_Num = ScGetLongValue(int Value_Type) |
||
ASCII Function |
int Mark_Num = ScCciGetLongValue(int Value_Type) |
||
Description |
Return the number of markings. |
||
Value_Type |
Type: int |
ID: |
|
Location: ScComSAMLightClientCtrlValueTypes |
|||
scComSAMLightClientCtrlLongValueTypeNumMarksCompleted |
1 |
||
Marks_Num |
Type: int |
Unit: none |
|
The number of markings. |
|||
CCI_Return |
Type: int |
||
CCI return number, see error list. |
|||
Notes |
- |
||
C# Example: Return the number of marks:
int Mark_Num = cci.ScGetLongValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeNumMarksCompleted ); |
Table 269: Number Marks Completed
☒ Set ☒ Get |
|||
---|---|---|---|
DLL Function |
int CCI_Return = ScSetLongValue(int Value_Type, int Quantity) int Quantity = ScGetLongValue(int Value_Type) |
||
ASCII Function |
int CCI_Return = ScCciSetLongValue(int Value_Type, int Quantity) int Quantity = ScCciGetLongValue(int Value_Type) |
||
Description |
Set or get the current quantity or maximum quantity. |
||
Value_Type |
Type: int |
ID: |
|
Location: ScComSAMLightClientCtrlValueTypes |
|||
scComSAMLightClientCtrlLongValueTypeQuantity |
5 |
||
Quantity. Quantity counter must be enabled. |
|||
scComSAMLightClientCtrlLongValueTypeMaxQuantity |
15 |
||
Maximum quantity, after that a message is shown. When a value of -1 is set, the quantity counter functionality is disabled. |
|||
Quantity |
Type: int |
Unit: none |
|
Returns the number of marks. |
|||
CCI_Return |
Type: int |
||
CCI return number, see error list. |
|||
Notes |
- |
||
C# Example: Get the current quantity:
int Quantity = cci.ScGetLongValue( ( int )ScComSAMLightClientCtrlValueTypes.scComSAMLightClientCtrlLongValueTypeQuantity ); |
Table 270: Quantity
☒ Set ☐ Get |
||
---|---|---|
DLL Function |
int CCI_Return = ScExecCommand(int Cmd_ID) |
|
ASCII Function |
int CCI_Return = ScCciExecCommand(int Cmd_ID) int CCI_Return = ScCciResetCounter() |
|
Description |
Resets the mark quantity counter. See chapter Mark Status Bar. |
|
Cmd_ID |
Type: int |
ID: |
Location: ScComSAMLightClientCtrlExecCommandConstants |
||
scComSAMLightClientCtrlExecCommandResetCounter |
7 |
|
CCI_Return |
Type: int |
|
CCI return number, see error list. |
||
Notes |
- |
|
C# Example: Reset counter |
Table 271: Reset Counter