ExportBatchIDToColumn (deprecated)

Exports the current Batch ID to the database column specified by the parameter. This action has been deprecated and is scheduled to be removed in a future release. It is recommended that you no longer use this action. Instead, use the ExportBatchIDToColumn action in the ExportToDatabase action library.

Syntax

bool ExportBatchIDToColumn (strParam)

Parameters

Three comma-separated values:
  1. The name of the database column that will hold the value.
  2. The name of the field whose value will be stored in the column.
  3. Optional: Can be set to the numerical value of 1, 2, or 3.

If this parameter is not specified, quotes will be placed around the value in the SQL query to update the table.

Setting the value to 1 causes this action to return False if the Table name is invalid; otherwise the error will not be discovered until the action that performs the DB insert call, such as an AddRecord action, is called. This value would typically only be used in a development environment as it will increase processing time.

Setting this value to 2 allows NULL column values and inserts no quotes around values (for numeric) in the SQL query to update the database.

Setting the value to 3 allows NULL and if the column value is not NULL, the column value will be surrounded in quotes in the SQL query to update the database.

Returns

False if the second parameter is set to "1" and the parameters do not identify a valid database column. Otherwise, True.

Level

All, but generally at the Page or Field level.

Details

Exports the current Batch ID to the database column specified by the parameter. The action also has an optional Style parameter with two values.
Example:
SetTableName("Export_Results")
ExportBatchIDToColumn("db_BatchID,1,2")
ExportFieldToColumn("Date,db_Date")
ExportFieldToColumn("Total,db_Total")
AddRecord()