Flush Method

Flushes the parser's or writer's buffers.

Syntax

ANSI (Cross Platform)
int Flush();

Unicode (Windows)
INT Flush();
- (void)flush;
#define MID_JSON_FLUSH 5

IPWORKSIOT_EXTERNAL int IPWORKSIOT_CALL IPWorksIoT_JSON_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

When Flush is called, the component flushes all its buffers, firing events as necessary.

When parsing, then the end state of the JSON is checked. If Validate is also true, the parser verifies that all open elements were closed, returning an error if not.

When writing, the resultant JSON is available in one of the output properties.

Output Properties

The class will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

  • OutputFile
  • OutputData: The output data is written to this property if no other destination is specified.

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

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks IoT 2020 C++ Edition - Version 20.0 [Build 8265]