RemoveElement Method

Removes the elment as the specified XPath.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int RemoveElement();

Unicode (Windows)
INT RemoveElement();

- (void)removeElement;

#define MID_XML_REMOVEELEMENT 18

IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_XML_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method removes the element specified by XPath.

When called the class will remove the element and its children from the internal representation of the XML (the DOM). This may be used at any time after Parse returns, or from within the EndElement event as a document is parsed in order to remove sections of a document that will not be needed later. By removing unnecessary elements from the DOM memory consumption is reduced and overall performance is improved.

RemoveElement Example:

Given the XML

<food>
	<fruits>
		<apple>
			<color>red</color>
		</apple>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

This code removes the apple element and its children.

xml.XPath = "/food/fruits/apple";
xml.RemoveElement(); 

The XML stored in the DOM is now:

<food>
	<fruits>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)