Top Method Summary
Options Name Purpose
LOGICAL AttachDataSource (handle) Attaches the Data-Source to the ProDataset buffer object handle
LOGICAL AttachDataSource (handle, character) Returns the handle of the data-source object
LOGICAL AttachDataSource (handle, character, character) Returns the handle of the data-source object
LOGICAL AttachDataSource (handle, character, character, character) Returns the handle of the data-source object
HANDLE GetBufferHandle (character) Returns the handle of a source buffer
HANDLE GetBufferHandle (integer) Returns the handle of a source buffer
Initialize () Initializes the DATA-SOURCE object handle and supporting objects
CHARACTER SourceColumn (character) Returns the database field name matching a temp-table field name contained in a consumers query string (query string vs. temp-table definition)
CHARACTER SourceDefaultQuery () Returns the default query string (USING OF) that can be used for the SourceDefaultQuery method of the DataAccess class
CHARACTER SourceDefaultQuery (logical) Returns the default query string (optionally resolving the OF) that can be used for the SourceDefaultQuery method of the DataAccess class

Top Property Summary
Options Name Purpose
HANDLE DataSourceHandle
LOGICAL Initialized


Method Detail
Top

LOGICAL AttachDataSource (handle)

Purpose: Attaches the Data-Source to the ProDataset buffer object handle
Notes:

Parameters:
phProDatasetBuffer HANDLE
The handle of the ProDataset buffer
Returns LOGICAL
Logical return value of the ATTACH-DATA-SOURCE method
Top

LOGICAL AttachDataSource (handle, character)

Purpose: Returns the handle of the data-source object
Notes: The implementation is required to remove and white space characters
from pcPairsList that might have been inserted to improve readability
but are not supported by the DATA-SOURCE

Parameters:
phProDatasetBuffer HANDLE
The handle of the ProDataset buffer
pcPairsList CHARACTER
pairs-list An optional character expression that evaluates to a comma-delimited list of field name pairs that specify a mapping between different field names in the data-source object buffer and the ProDataSet temp-table buffer
Returns LOGICAL
Logical return value of the ATTACH-DATA-SOURCE method
Top

LOGICAL AttachDataSource (handle, character, character)

Purpose: Returns the handle of the data-source object
Notes: The implementation is required to remove and white space characters
from pcPairsList that might have been inserted to improve readability
but are not supported by the DATA-SOURCE

Parameters:
phProDatasetBuffer HANDLE
The handle of the ProDataset buffer
pcPairsList CHARACTER
pairs-list An optional character expression that evaluates to a comma-delimited list of field name pairs that specify a mapping between different field names in the data-source object buffer and the ProDataSet temp-table buffer
pcExceptList CHARACTER
An optional character expression that evaluates to a comma-separated list of fields in the ProDataSet object buffer that will not be populated with data from the data source
Returns LOGICAL
Logical return value of the ATTACH-DATA-SOURCE method
Top

LOGICAL AttachDataSource (handle, character, character, character)

Purpose: Returns the handle of the data-source object
Notes: The implementation is required to remove and white space characters
from pcPairsList that might have been inserted to improve readability
but are not supported by the DATA-SOURCE

Parameters:
phProDatasetBuffer HANDLE
The handle of the ProDataset buffer
pcPairsList CHARACTER
pairs-list An optional character expression that evaluates to a comma-delimited list of field name pairs that specify a mapping between different field names in the data-source object buffer and the ProDataSet temp-table buffer
pcExceptList CHARACTER
An optional character expression that evaluates to a comma-separated list of fields in the ProDataSet object buffer that will not be populated with data from the data source
pcIncludeList CHARACTER
An optional character expression that evaluates to a comma-separated list of fields to include in the ProDataSet object buffer, as an alternative to specifying fields to exclude in except-fields.
Returns LOGICAL
Logical return value of the ATTACH-DATA-SOURCE method
Top

HANDLE GetBufferHandle (character)

Purpose: Returns the handle of a source buffer
Notes:

Parameters:
pcBufferName CHARACTER
The name of the buffer
Returns HANDLE
The handle of the data-source object
Top

HANDLE GetBufferHandle (integer)

Purpose: Returns the handle of a source buffer
Notes:

Parameters:
piIndex INTEGER
The index of the buffer
Returns HANDLE
The handle of the data-source object
Top

Initialize ()

Purpose: Initializes the DATA-SOURCE object handle and supporting objects
Notes:

Top

CHARACTER SourceColumn (character)

Purpose: Returns the database field name matching a temp-table field name
contained in a consumers query string (query string vs. temp-table
definition)
Notes: To be used in the DataAccess:SourceColumn method

Parameters:
pcColumn CHARACTER
The temp table column name to return the source (database table) field name for
Returns CHARACTER
The database field name mapped to the passed in temp-table field
Top

CHARACTER SourceDefaultQuery ()

Purpose: Returns the default query string (USING OF) that can be used for the
SourceDefaultQuery method of the DataAccess class
Notes: Can not be used, when the buffers cannot be joined using OF

Returns CHARACTER
The query string for the source default query
Top

CHARACTER SourceDefaultQuery (logical)

Purpose: Returns the default query string (optionally resolving the OF) that can be used for the
SourceDefaultQuery method of the DataAccess class
Notes: Can not be used, when the buffers cannot be joined using OF

Parameters:
plResolveOf LOGICAL
Logical value indicating if the OF relation shoudl be resolved into a WHERE clause
Returns CHARACTER
The query string for the source default query


Property Detail
Top

HANDLE DataSourceHandle


Returns HANDLE
Top

LOGICAL Initialized


Returns LOGICAL


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       30.03.2026 11:05:05