Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# DocumentAuthenticator.appendFrame Method

Module: DocumentAuthenticator

## Definition

Appends a frame in the FIFO buffer.

Python

    append_frame(self, image: DocumentImage) -> None

Parameters

> `image` DocumentImage
> in Source image of the aligned document to append

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Dart

    void appendFrame(DocumentImage image)

Parameters

> `image` DocumentImage
> in Source image of the aligned document to append

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

C#

    public void AppendFrame(DocumentImage image)

Parameters

> `image` DocumentImage
> in Source image of the aligned document to append

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Java

    public void appendFrame(DocumentImage image) throws DocumentException

Parameters

> `image` DocumentImage
> in Source image of the aligned document to append

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

Swift

    public func appendFrame(image: DocumentImage) throws

Parameters

> `image` DocumentImage
> in Source image of the aligned document to append

Exceptions

> DocumentException
> An error has occurred during Document Library execution.

C

    int id3DocumentAuthenticator_AppendFrame (
        ID3_DOCUMENT_AUTHENTICATOR hDocumentAuthenticator,
        ID3_DOCUMENT_IMAGE hImage)

Parameters

> `hDocumentAuthenticator` ID3_DOCUMENT_AUTHENTICATOR
> in Handle to the DocumentAuthenticator object.
> `hImage` ID3_DOCUMENT_IMAGE
> in Source image of the aligned document to append

Returns

> `int`
> An error code.
> See id3DocumentError file for the list of possible error codes.