FCFL.NET Common Library - API Reference
AddStatement Method

An unprepared SQL statement (with the {n} and {DATE} parameters still present)
A collection of parameters to use with the supplied sqlStmt parameter. The number of parameters must match the number of {n} arguments in the SQL statement. Each parameter in the collection must have a unique name with respect to all the other parameters in all the other queries in this batch. To guarantee uniqueness among parameters, see the GetUniqueParamName Method.
Adds an unprepared SQL statement (with the {n} and {DATE} parameters still present) to the list of statements to execute during the batch or executes it immediately if batching is not available or disabled
Syntax
'Declaration
 
Public Sub AddStatement( _
   ByVal sqlStmt As String, _
   ByVal cmdParams As DataParameterCollection _
) 
public void AddStatement( 
   string sqlStmt,
   DataParameterCollection cmdParams
)

Parameters

sqlStmt
An unprepared SQL statement (with the {n} and {DATE} parameters still present)
cmdParams
A collection of parameters to use with the supplied sqlStmt parameter. The number of parameters must match the number of {n} arguments in the SQL statement. Each parameter in the collection must have a unique name with respect to all the other parameters in all the other queries in this batch. To guarantee uniqueness among parameters, see the GetUniqueParamName Method.
Remarks

Once added, the statement is rewritten to make the parameter names unique among all the statements. Once added a statement cannot be removed. The entire batch must be discarded and rebuilt.

If the specified provider for this batch returns false from its CanBatchQueries property, the statement will be executed immediately and not added to a batch. No statement will be added to a "batch". Subsequent calls to the Execute Method will not perform any operations against the database and return a -2 for number of rows affected.

If the specified provider returns true from its CanBatchQueries property, this statement will be added to the list of statements to execute in the batch when the Execute Method is called.

IMPORTANT: The UpdateQueryBatch does not commit or rollback the transaction instance. It is the responsibility of the caller to ensure that the transaction is properly set up and finished after the batch is executed.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Reference

UpdateQueryBatch Class
UpdateQueryBatch Members

 

 


© 2010 Dovetail Software, Inc. - All rights reserved.
- Clarify, Amdocs, and related products and names are copyright and trademark of Amdocs, Inc.
- .NET, Visual Studio.NET, C#, Visual Basic and related products are trademark of Microsoft corporation.

Send comments on this topic.