Flush Method

Flushes the parser and checks its end state.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int Flush();

Unicode (Windows)
INT Flush();

- (void)flush;

#define MID_XML_FLUSH 4

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

Remarks

When Flush is called, the parser flushes all its buffers, firing events as necessary, and then checks its end state. If Validate is true, the parser verifies that all open elements were closed, returning an error if not.

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.)