ImgErr_SetInfo_JSN¶
Set the Q2Pix error info for the current process.
ImgErr_SetInfo_JSN(errInfoJSON)
| → | errInfoJSON |
Text | Error info in JSON format. |
Set the Q2Pix error info for the current process.
The error info is specified in errInfoJSON, a 4D object serialized in JSON format.
If an empty string is passed, the error info is cleared.
The error info object contains the following properties:
| Property name | Type | Description |
|---|---|---|
Domain |
String |
The domain of the error. For errors triggered by Q2Pix the domain will be "Q2Pix".
Other possible values include (but are not limited to) "POSIX", "Cocoa" (on macOS),
"WIC", "D2D", "Win32" (on Windows), and "Pdfium". |
Code |
Longint |
The error code, interpreted in the specific domain. |
Description |
String |
The description of the error (optional). |
Reason |
String |
The reason why the error happened (optional). |
Method |
String |
The method where the error occurred (optional). |
When setting the Q2Pix error info, at least the Domain and Code properties in the
errInfoJSON object must be specified.
This method is primarily for use by components or code modules built around Q2Pix in order to communicate error information to their callers using the same mechanism.
Note
The ImgErr_SetInfo and ImgErr_Clear methods in the
Q2PixLib component are wrappers to this method.
