GAMS Data Exchange API

TGXFileObj
Page 42
TGXFileObj.gdxDataReadStr
Read the next record in string mode
function gdxDataReadStr(var KeyStr: TgdxStrIndex; var Values: TgdxValues; var DimFrst:
integer): integer;
Parameters
var KeyStr: TgdxStrIndex
The index of the record as strings for the unique elements
var Values: TgdxValues
The data of the record
var DimFrst: integer
The first index position in KeyStr that changed
Return Value
Non-zero if the operation is possible; return zero if the operation is not possible or if there is no more data
Description
Read the next record using strings for the unique elements. The reading should be initialized by calling DataReadStrStart
See Also
TGXFileObj.gdxDataReadStrStart ( see page 42), TGXFileObj.gdxDataReadDone ( see page 38)
TGXFileObj.gdxDataReadStrStart
Initialize the reading of a symbol in string mode
function gdxDataReadStrStart(SyNr: integer; var NrRecs: integer): integer;
Parameters
SyNr: integer
The index number of the symbol, range 0..NrSymbols; SyNr = 0 reads universe
var NrRecs: integer
The number of records available for reading
Return Value
Non-zero if the operation is possible, zero otherwise
Description
Reading data using strings is the simplest way to read data. Every record read using DataReadStr will return the strings for the
unique elements. Internal mapping is not affected by this function.
See Also
TGXFileObj.gdxDataReadStr ( see page 42), TGXFileObj.gdxDataReadRawStart ( see page 40),
TGXFileObj.gdxDataReadMapStart ( see page 39), TGXFileObj.gdxDataReadDone ( see page 38)
Examples
Example
if DataReadStrStart(PGX,1,NrRecs)
then
begin
while DataReadStr(PGX,Uels,Vals)
do [...]
DataReadDone(PGX)
Symbol Reference Classes GAMS Data Exchange API
2.1
Page 42 2.4
12/3/2012