GetRecordSource Method (DataSource)

Processes the PARAMETERS clause in the DataSource.RecordSource string and returns the result.

Syntax

Visual Basic
C#

'Declaration
 
Public Function GetRecordSource( _
   ByVal prompt As Boolean _
) As String

public string GetRecordSource( 
   bool prompt
)

Parameters

prompt: If set to true, user will be prompted for the parameters before the method returns. If set to false, the default values will be used.

Return Value

The string (SQL statement or table name) that can be used to open a recordset.

Remarks

This property is related to the DataSource.RecordSource property. The DataSource.RecordSource property sets or returns a string that specifies the source dataset for the report, and it may contain a PARAMETERS clause that causes C1Report to prompt the user for information.

If you wanted to use the value of the DataSource.RecordSource property to open a dataset directly from your program, you would have to parse the PARAMETERS clause yourself.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DataSource Class
DataSource Members