MarkForDelete

Syntax

MarkForDelete (mapName, elementName, elementValue)

Description

Delete a value in a cross-reference map when the element specified is the only element for a single domain. If multiple domains reference the element, or the element is used in a domain containing multiple primary elements, the xref:markForDeleteNVP function should be used instead. The values in the elements are marked as deleted. If only two mappings are in a row and one of them is marked for deletion, then the value in the other domain will also be deleted. Any element value marked for delete is treated as if the value does not exist. Therefore, you can populate the same element with the xref:populateXRefRow function in ADD mode. However, using the element value marked for delete as a reference value in the LINK mode of the xref:populateXRefRow function would cause an error.

Parameters

Parameter Description

mapName

Name of a dynamic (cross-reference) value map definition, as string.

elementName

Name of the element in the Xref from which to delete a value, as string.

elementValue

Value of the element in the Xref to be deleted, as string.

Returns

True if the delete succeeds.

Example

This example will delete the PS001 value in the PS element of the Customers cross-reference map:

&return=&xref.MarkForDelete("Customers", "PS", "PS001")