Windward Engine API Reference
BatchSetup Method
See Also  Send comments on this topic.
net.windward.api.csharp Namespace > Report Class : BatchSetup Method




dataProviders
All of the datasources to process. key = the name of the datasource, value = the datasource.
batchForEach
The text of a forEach tag that is the batch query. The datasource for this tag must be in the dataProviders.
batchParameters
Parameters that may have ${var} parameters in the value part of the entry. This is returned in each iteration with the ${var} values substituted with the string value of that var.The key value is ignored by the engine.

Glossary Item Box

Prepares the object to run batch reports. Call processSetup() before calling this method. Do not call processData() or processComplete() after calling this method.After this setup batchNext() can be called repetitively for each batched report.

Syntax

Visual Basic (Declaration) 
Public Sub BatchSetup( _
   ByVal dataProviders As IDictionary(Of String,IReportDataSource), _
   ByVal batchForEach As String, _
   ByVal batchParameters As IDictionary(Of String,String) _
) 
Visual Basic (Usage)Copy Code
Dim instance As Report
Dim dataProviders As IDictionary(Of String,IReportDataSource)
Dim batchForEach As String
Dim batchParameters As IDictionary(Of String,String)
 
instance.BatchSetup(dataProviders, batchForEach, batchParameters)
Managed Extensions for C++ 
public: void BatchSetup( 
   IDictionary<string*,IReportDataSource*>* dataProviders,
   string* batchForEach,
   IDictionary<string*,string*>* batchParameters
) 

Parameters

dataProviders
All of the datasources to process. key = the name of the datasource, value = the datasource.
batchForEach
The text of a forEach tag that is the batch query. The datasource for this tag must be in the dataProviders.
batchParameters
Parameters that may have ${var} parameters in the value part of the entry. This is returned in each iteration with the ${var} values substituted with the string value of that var.The key value is ignored by the engine.

Requirements

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

See Also

© 2019 All Rights Reserved.