xref:markForDeleteNVP
Syntax
xref:markForDeleteNVP(mapName, referenceDomain, referenceNVP)
Description
Use the xref:markForDeleteNVP function to delete a set of values in a cross-reference map for a specified domain. The values in the elements are marked as deleted.
A cross-reference map row should have at least two mappings. Therefore, if you have only two mappings in a row and you mark one value for delete, then the value in the other domain is also deleted.
Any values marked for delete are treated as if they do not exist. Therefore, you can populate the same elements with the xref:populateXRefRowNVP function in ADD mode. However, if the element value is marked for delete as a reference, it cannot be used in the LINK mode of xref:populateXRefRowNVP function.
Parameters
| Parameter | Description |
|---|---|
|
mapName |
The cross-reference map name, as string. |
|
referenceDomain |
The name of the reference domain, as string. |
|
referenceNVP |
NVP list of reference elements and values that you want to delete, as string. |
Returns
This function returns true if deletion was successful; otherwise, it returns false.
An exception can occur for the following reasons:
-
The cross-reference map with the given name is not found.
-
The specified element name is not found.
-
All primary elements in this domain have not been specified.
-
The specified value is empty.
-
The specified value is not found in the element.
-
Multiple values are found.
Example
The following code deletes the specified values in the Setid and ItemID elements of the PeopleSoft domain from the Items cross-reference map:
xref:markForDeleteNVP ("Items","PeopleSoft","<Setid>SHARE</Setid><ItemID>1000⇒
</ItemID>")