AddRetrieveObject

Description

Adds the DataWindow, DataWindowChild, or DataStore that need to retrieve data, so that these objects can retrieve data in one request.

Applies to

BatchDataObjects object

Syntax

objectname.addretrieveobject ( datawindow obj {, any b[] } )

Argument

Description

objectname

A reference to the BatchDataObjects object.

obj

The DataWindow control, DataStore, or child DataWindow to be added to the BatchDataObjects object.

b

(Optional) One or more values that you want to use as retrieval arguments in the SQL SELECT statement defined in DataWindow/DataStore/DataWindowChild.


Return value

Integer.

Returns the index of the DataWindow if it succeeds and -1 if an error occurs. If any argument's value is null, the method returns null.

Examples

The following code example adds a DataWindow without retrieval argument:

BatchDataObjects lbdo_test
int li_return
li_return = lbdo_test. AddRetrieveObject (dw_3)

The following code example adds a DataWindow with one retrieval argument:

BatchDataObjects lbdo_test
int li_return
li_return = lbdo_test. AddRetrieveObject (lds_test, 3)

The following code example adds a DataWindow with two retrieval arguments:

BatchDataObjects lbdo_test
int li_return
li_return = lbdo_test. AddRetrieveObject (dw_test, 3, 'test')

See also

AddUpdateObject

GetCount

Reset