22.04.2013 Views

GAMS Data Exchange API

GAMS Data Exchange API

GAMS Data Exchange API

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

TGXFileObj<br />

Page 44<br />

Name of the symbol<br />

const ExplTxt: ShortString<br />

Explanatory text for the symbol<br />

Dimen: integer<br />

Dimension of the symbol<br />

UserInfo: integer<br />

See gdx<strong>Data</strong>WriteRawStart ( see TGXFileObj.gdx<strong>Data</strong>WriteRawStart, page 44) for more information<br />

Type<br />

Type of the symbol<br />

Return Value<br />

Non-zero if the operation is possible, zero otherwise<br />

See Also<br />

TGXFileObj.gdx<strong>Data</strong>WriteMap ( see page 43), TGXFileObj.gdx<strong>Data</strong>WriteDone ( see page 43)<br />

TGXFileObj.gdx<strong>Data</strong>WriteRaw<br />

Write a data element in raw mode<br />

function gdx<strong>Data</strong>WriteRaw(const KeyInt: TgdxUELIndex; const Values: TgdxValues): integer;<br />

Parameters<br />

const KeyInt: TgdxUELIndex<br />

The index for this element<br />

const Values: TgdxValues<br />

The values for this element<br />

Return Value<br />

Non-zero if the operation is possible, zero otherwise<br />

Description<br />

When writing data in raw mode, the index space used is based on the internal index space. The indices used are in the range<br />

1..NrUels but this is not enforced. Before we can write in raw mode, the unique elements (strings) should be registered first.<br />

When writing raw, it assumed that the records are written in sorted order and that there are no duplicate records. Records that<br />

are not in sorted order or are duplicates will be added to the error list (see <strong>Data</strong>ErrorCount and <strong>Data</strong>ErrorRecord)<br />

See Also<br />

TGXFileObj.gdx<strong>Data</strong>WriteRawStart ( see page 44), TGXFileObj.gdx<strong>Data</strong>WriteDone ( see page 43)<br />

TGXFileObj.gdx<strong>Data</strong>WriteRawStart<br />

Start writing a new symbol in raw mode<br />

function gdx<strong>Data</strong>WriteRawStart(const SyId: ShortString; const ExplTxt: ShortString; Dimen:<br />

integer; Typ: integer; UserInfo: integer): integer;<br />

Parameters<br />

const SyId: ShortString<br />

Name of the symbol<br />

const ExplTxt: ShortString<br />

Explanatory text for the symbol<br />

Dimen: integer<br />

Dimension of the symbol<br />

Typ: integer<br />

Symbol Reference Classes <strong>GAMS</strong> <strong>Data</strong> <strong>Exchange</strong> <strong>API</strong><br />

2.1<br />

Page 44 2.4<br />

12/3/2012

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!