RemoveCustomTable

You can use this function for Optiva Workflows and Copy Methods.

Purpose

The function RemoveCustomeTable removes all rows from an extension table for an object.

Syntax


long RemoveCustomTable(string DataTableName, string objSymbol, string objKey)

Return Value

If the code is successful a value greater than zero (0) is displayed. or else failed.

Arguments

Part Description
DataTableName The name of the Extension/custom table (as per Extension table definition) related to the specific object.
objSymbol The object type or current object type of the data.
Note: Use empty quotation marks to indicate the current symbol of the workflow.
objkey The object key or the current object key of the data.
Note: Use empty quotation marks to indicate the current object of the workflow.

Description

Use this function to delete all rows from an extension table for an object. Use for tables where users can add rows.

Examples

This example removes all rows from CustomTable1 for the item 10001.


Dim sRemoveCustomTable As String = RemoveCustomTable

("CustomTable1", "ITEM", "10001")

This example removes all rows from CustomTable1 for a new formula. The new formula is being created by a copy method.


Dim sRemoveCustomTable As String = RemoveCustomTable("CustomTable1")
Example 1: This example removes all rows from the custom extension table named CustomTable1 for the item object with key "T0001".
RemoveCustomTable("CustomTable1", "ITEM", "T0001");
Example 2: This example removes all rows from the custom extension table named CustomTable2 for the current object of the workflow.
RemoveCustomTable("CustomTable2", " ", " ");