Data Access Class (clsDataAccess)

fdmAPI.API.DataWindow.DataAccess.API Call

Table 7-9 Data Access Class (clsDataAccess)

API Call	Method/Property/Object Reference	Description
farsFireHose	Method	Open an ADO forward only/read only recordset for fast data streaming. Inputs: ByVal strSQL As String, Optional ByVal blnServerCursor As Boolean, Optional ByVal lngMarshalType As Long strSQL—SQL statement to execute blnServerCursor—Optional, Cursor location switch (True=Database Server,False=Client) lngMarshalType—Optional, Value used to control how the recordset is returned Output: ADODB Recordset
farsKeySet	Method	Open an ADO keyset type recordset based on the specified lock type. Inputs: Inputs: ByVal strSQL As String, Optional ByVal lngLockType As Long, Optional ByVal blnServerCursor As Boolean, Optional ByVal lngMarshalType As Long strSQL—SQL statement to execute lngLockType—ADO LockTypeEnum (adLockReadOnly=1;adLockPesimistic=2;adLockOptimistic=3;adLockBatch Optimistic=4) blnServerCursor—Optional, cursor location switch (True=Database Server,False=Client) lngMarshalType—Optional, Value used to control how the recordset is returned. Output: ADODB.Recordset
farsPage	Method	Open an ADO BatchOptimistic recordset limited to the records found on the specified page. The record set returned is programmatically created and is disconnected. Inputs: ByVal strSQL As String, ByVal lngPageSize As Long, ByVal lngPage As Long, lngOPRecordCount As Long, Optional ByVal lngMarshalType As Long strSQL—SQL statement to execute lngPageSize—Number of records per page lngPage—Desired page number lngOPRecordCount—Output parameter containing record set record count lngMarshalType—Optional, Value used to control how the record set is returned Output: ADODB.Recordset
farsPageFind	Method	Open an ADO BatchOptimistic recordset limited to the records found on the specified page and for the specified criteria. The recordset returned is programmatically created and is disconnected. Inputs: ByVal strSQL As String, ByVal strCriteria As String, ByVal lngStartPosition As Long, ByVal lngPageSize As Long, lngOPRecordCount As Long, lngOPFindPostion As Long, Optional ByVal lngMarshalType As Long strSQL—SQL statement to execute strCriteria—ADO recordset FIND criteria statement (See ADO FIND method) lngStartPosition—Record index to begin the search lngPageSize—Number of records per page lngPage—Desired page number lngOPRecordCount—Output parameter containing recordset record count lngOPFindPostion—Output parameter containing position where record was found lngMarshalType—Optional, Value used to control how the recordset is returned Output: ADODB.Recordset
farsPageFindFromKey	Method	Open an ADO BatchOptimistic recordset limited to the records found on the specified page and for the specified criteria. The recordset returned is programmatically created and is disconnected. Inputs: ByVal strSelect As String, ByVal strFrom As String, ByVal strWhere As String, ByVal strGroupBy As String, ByVal strHaving As String, ByVal strOrderBy As String, ByVal strKeyFieldName As String, ByVal strFindFieldName As String, ByVal strCriteria As String, ByVal lngStartPosition As Long, ByVal lngPageSize As Long, lngOPRecordCount As Long, lngOPFindPostion As Long, Optional ByVal lngMarshalType—As Long strSelect—Select clause of SQL statement to execute strFrom—From clause of SQL statement to execute strWhere—Where clause of SQL statement to execute strGroupBy GroupBy—Clause of SQL statement to execute strHaving—Having clause of SQL statement to execute strOrderBy OrderBy—Clause of SQL statement to execute strKeyFieldName—Name of key field used for fast page location strFindFieldName—Name of the field used in the find criteria strCriteria—Find criteria statement lngStartPosition—Record index to begin the search lngPageSize—Number of records per page lngPage—Desired page number lngOPRecordCount—Output parameter containing recordset record count lngOPFindPostion—Output parameter containing position where record was found lngMarshalType—Optional, Value used to control how the recordset is returned Output: ADODB.Recordset
farsPageFromKey	Method	Open an ADO BatchOptimistic recordset limited to the records found on the specified page. This method is optimized for high volume queries. The recordset returned is programmatically created and is disconnected. Inputs: ByVal strSelect As String, ByVal strFrom As String, ByVal strWhere As String, ByVal strGroupBy As String, ByVal strHaving As String, ByVal strOrderBy As String, ByVal strKeyFieldName As String, ByVal lngPageSize As Long, ByVal lngPage As Long, lngOPRecordCount As Long, Optional ByVal lngMarshalType As Long strSelect—Select clause of SQL statement to execute strFrom—From clause of SQL statement to execute strWhere—Where clause of SQL statement to execute strGroupBy—GroupBy clause of SQL statement to execute strHaving—Having clause of SQL statement to execute strOrderBy—OrderBy clause of SQL statement to execute strKeyFieldName—Name of key field used for fast page location lngPageSize—Number of records per page lngPage—Desired page number lngOPRecordCount—Output parameter containing recordset record count lngMarshalType—Optional, Value used to control how the recordset is returned Output: ADODB.Recordset
farsSnap	Method	Open an ADO static type read only recordset. Inputs: ByVal strSQL As String, Optional ByVal blnServerCursor As Boolean, Optional ByVal lngMarshalType As Long strSQL—SQL statement to execute blnServerCursor—Optional, cursor location switch (True=Database Server,False=Client) lngMarshalType—Optional, Value used to control how the recordset is returned Outputs:ADODB.Recordset
farsTableAppend	Method	Open an ADO keyset type recordset based on the specified lock type using the ADO "Table Direct "command directive and with the "Append-Only Rowset " property set to true. Inputs: ByVal strTableName As String, Optional ByVal lngMarshalType As Long strTableName—Name of table to open lngMarshalType—Optional, Value used to control how the recordset is returned Outputs: ADODB.Recordset