IGR_Canvas_Annotate_JSON¶

IGR_Canvas_Annotate_JSON draws the given annotation onto the current page. The annotation is delivered as a string of JSON text. The schema for Annotations can be found in the Document Filters installation directory in “Annotation-Schema.json”.

Prototype¶

C/C++

IGR_LONG IGR_Canvas_Annotation_JSON(
    HCANVAS Canvas,
    const IGR_UCS2* Json,
    Error_Control_Block* ISYSError);

Parameters¶

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

Json: Unicode string (UCS2)

The json payload of the annotation to render to output of the canvas. The string must be NULL terminated.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

Return value¶

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

Additional information¶

Note Annotations are supported for bitmap, PDF and HTML canvas, however are only end-user interactive in PDF output. For other output types, the annotation is flattened/rastered into the output