RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
TLocalAppServer.AS_GetRecords Method
TLocalAppServer Class | TLocalAppServer Members | Provider Namespace | Description | See Also
Collapse All

Returns a data packet that contains the specified data.

Pascal
function AS_GetRecords(const ProviderName: WideString; Count: Integer; out RecsOut: Integer; Options: Integer; const CommandText: WideString; var Params: OleVariant; var OwnerData: OleVariant): OleVariant; safecall;
C++
__fastcall OleVariant AS_GetRecords(const BSTR ProviderName, int Count, int RecsOut, int Options, const BSTR CommandText, OleVariant Params, OleVariant OwnerData);
Description

Call AS_AS_GetRecords to retrieve a specified number of records. AS_GetRecords returns the requested records, starting with the current record of the provider's dataset. When working with a stateless remote data module, you may need to reposition the cursor or re-execute a query or stored procedure in the provider's BeforeAS_GetRecords event handler. 

ProviderName gives the name of the provider component that provides the records.  

Count indicates the number or type of records to retrieve. If Count is -1, all records are retrieved. If Count is 0, only metadata is retrieved. If Count is greater than 0, only Count records are retrieved.  

RecsOut returns the actual number of records retrieved. 

Options indicates what information should be added to the data packet in addition to data. It is a combination of the GetRecordOption constants. For example, the following value requests metadata along with a data packet encoded in XML:

Copy Code

 

Copy Code

CommandText specifies an optional SQL statement that replaces the SQL of a query, or the name of a table or stored procedure that replaces the provider's table or stored procedure. This parameter is ignored if the Options property does not include poAllowCommandText. 

Params is a Variant containing any parameters that should be passed to the provider's dataset before it executes to generate the requested data. It returns any output parameters. You can convert between the Variant format for parameters used by this argument and a TParams object using the global PackageParams and UnpackParams routines. 

OwnerData contains custom information that is supplied by a client dataset's BeforeAS_GetRecords event handler. This information is passed to the provider's BeforeAS_GetRecords event handler. OwnerData returns information supplied by the provider's AfterAS_GetRecords event handler. 

Records are returned as a data packet in a Variantparameter, AS_GetRecords_result (C++). 

 

See Also
Copyright(C) 2008 CodeGear(TM). All Rights Reserved.
What do you think about this topic? Send feedback!