PrepareInstancePageQueryCommand Method (StorageSqlDbDataAccessAgent)

Initializes a System.Data.IDbCommand object to query for Composite Instance information using matching parameters for pagination.

Syntax

C#
Visual Basic
Objective-C
Java
C++

protected override void PrepareInstancePageQueryCommand( 
   IDbCommand command,
   Collection<CatalogElement[]> matchingParamsCollection,
   QueryPageInfo queryPageInfo
)

'Declaration
 
Protected Overrides Sub PrepareInstancePageQueryCommand( _
   ByVal command As IDbCommand, _
   ByVal matchingParamsCollection As Collection(Of CatalogElement()), _
   ByVal queryPageInfo As QueryPageInfo _
)

'Usage
 
Dim instance As StorageSqlDbDataAccessAgent
Dim command As IDbCommand
Dim matchingParamsCollection As Collection(Of CatalogElement())
Dim queryPageInfo As QueryPageInfo
 
instance.PrepareInstancePageQueryCommand(command, matchingParamsCollection, queryPageInfo)

protected:
void PrepareInstancePageQueryCommand( 
   IDbCommand^ command,
   Collection<array<CatalogElement^>>^ matchingParamsCollection,
   QueryPageInfo^ queryPageInfo
) override

Parameters

command: Type: System.Data.IDbCommand The database command that will be initialized to execute the query.
matchingParamsCollection: Type: Collection of Leadtools.Medical.DataAccessLayer.Catalog.CatalogElement Array The matching parameters for the query.
queryPageInfo: Type: Leadtools.Medical.DataAccessLayer.QueryPageInfo Specifies the page number and page size that will result from the executing the query.

Remarks

This is similar to the PrepareInstancePageQueryCommand method, except that the query will generate paginated results. The queryPageInfo is used to specify a page number and page size for the results. For example, suppose that the executing the query returns 100 rows. If queryPageInfo specifies a page size of 10, and a page number of 3. Executing the query will then return 10 total rows (the page size) starting with row 30 (PageNumber * PageSize). Therefore, the result would be rows 30 through 40.

Requirements

Target Platforms

Reference

StorageSqlDbDataAccessAgent Class
StorageSqlDbDataAccessAgent Members