cnv.AddAnnotations

This job burns annotations (slides) into one or more image files.

The job respects the access rights on the annotations. For example, only the personal slide of the logged-in user is displayed.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

0 = The input files are deleted; temporary copies are created for unchanged input files.
2 = Input files are not deleted; unchanged input files are written back to the output list.

[AnnotationID]

INT

No

Specific ID of an annotation to be burned into the input file(s).

[dwObjectID]

INT

No

ID of an object to be burned into the input file(s). AnnotationID can be passed, dwObjectID must be passed for this.

2. Input Files

Name Description

File List

Paths and names of files to be annotated.

3. Output Parameters

Name Type Dependency Description

nProcessed

INT

—

Number of image files that were annotated.

sAnnotationIDs

STRING

—

Comma-separated list of annotation IDs that were burned in.

4. Output Files

Name Description

File List

Path and name of the image file that was annotated, if annotations were present for this input file. Otherwise, the input file is returned unchanged (see Flags). The output format corresponds to the respective input file format.

5. Return Value

(INT): 0 = Job successful, otherwise error code.