NodeDelete function

Syntax

NodeDelete(nodeName)

Description

Use the NodeDelete function to delete the specified node and all subordinate objects (transactions, node properties, certificates, and so on.)

WARNING:

Once this function has completed, you cannot recover the node.

Parameters

Parameter	Description
nodeName	Specify the name of the node you want to delete, as a string. All node names are uppercase.

Returns

A Boolean value: True, the function completed successfully deleted, False otherwise.

Example

&Rslt = NodeDelete("QEM_TEST_NODE");

If Not &Rslt Then

   /* Do error processing */

End-if;

Event Considerations

PeopleSoft recommends only using this function in the SavePostChange event. In addition, you should put a warning in the SaveEdit event, so the user has a chance to change their mind about deleting the node.

If you use a push button on a page to delete a node, PeopleSoft recommends the following code in the FieldChange event:

If %Page = Page.YourDeletePage Then 
/* changes the record in the buffer so that the DoSaveNow fires */ 
   PSMSGNODEDEFN.DESCR = PSMSGNODEDEFN.DESCR | " ";   
   DoSaveNow(); 
   ClearKeyList(); 
/* Transfer to another component or display information message; */  
End-If;