Gatheringdatamultiplelinesget - Newport XPS Programmer's Manual

XPS Unified
7.2.1.43

GatheringDataMultipleLinesGet

Name
GatheringDataMultipleLinesGet – Reads several data lines from the current gathering
buffer in memory.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks index number: (-17)
• IndexPoint ≥ 0 (Note: index #0 = line #1)
• IndexPoint <currently gathered data number.
- Checks gathering state: (-32)
Description
This function reads one or several data lines from the current gathering buffer. The
buffer line number is defined by the index of an acquired point.
The separator is ";" in the returned data line and the end of each line is carriage return
"\n".
Gathering must be configured in order to use this function, otherwise (-32) error is
returned.
Example of gathering buffer in memory:
index Data1
0 →
1 →
2 →
3 →
5 →
GatheringDataMultipleLinesGet(0, 3, myString)
= >0 = the start line is #1
= >3 = the number of lines to read is 3
= >myString = buffer to get the part of buffer (32767 characters maximum)
index Data1
0 →
1 →
2 →
3 →
5 →
"myString" result:
1;10;0.1;21;100
2;20;0.2;22;102
3;30;0.3;23;103
Data2
1 10
2 20
3 30
4 40
5 50
Data2
1 10
2 20
3 30
4 40
5 50
89
Programmer's Manual
Data3 Data4
0.1 21
0.2 22
0.3 23
0.4 24
0.5 25
Data3 Data4
0.1 21
0.2 22
0.3 23
0.4 24
0.5 25
EDH0373En1023 — 01/18
Data5
100
102
103
104
105
Data5
100
102
103
104
105