.. index:: 
  !DocumentError Enumeration

.. _id3_document_document_error_enum:

===============================================================================
DocumentError Enumeration
===============================================================================

Namespace: :ref:`id3.Document<reference_document>`

Definition
----------

.. line-block::
    Enumerates possible error codes.

.. tab-set::

  .. tab-item:: Python
    :sync: Python

    .. code-block:: Python

      class DocumentError

  .. tab-item:: Dart
    :sync: Dart

    .. code-block:: Dart

      enum DocumentError

  .. tab-item:: C#
    :sync: C#

    .. code-block:: C#

      public enum DocumentError

  .. tab-item:: Java
    :sync: Java

    .. code-block:: Java

      public enum DocumentError

  .. tab-item:: Swift
    :sync: Swift

    .. code-block:: Swift

      public enum DocumentError

  .. tab-item:: C
    :sync: C

    .. code-block:: C

      typedef enum id3DocumentError


Fields
------

.. list-table:: 
  :width: 100%
  :widths: 5 5 90
  :header-rows: 1

  * - Name
    - Value
    - Description
  * - ``success``
    - 0
    - No error.
  * - ``insufficientBuffer``
    - -1
    - The given buffer is too small.
  * - ``objectDoesNotExist``
    - -2
    - The requested object does not exist; a 'null' should be returned if possible.
  * - ``base``
    - -11000
    - Base error code of the Document module.
  * - ``minimum``
    - -11999
    - Minimum error code of the Document module.
  * - ``invalidHandle``
    - -11001
    - The handle is invalid.
  * - ``invalidParameter``
    - -11002
    - The parameter is invalid.
  * - ``invalidPixelFormat``
    - -11004
    - The image pixel format is invalid.
  * - ``invalidModelPath``
    - -11008
    - The model could not be found in the given directory path.
  * - ``invalidDocumentTemplatePath``
    - -11009
    - The document template could not be found at the given path.
  * - ``unloadedModel``
    - -11020
    - The model which is required for this operation has not been  loaded.
  * - ``unloadedDocumentTemplate``
    - -11021
    - The document template required for this operation has not been loaded.
  * - ``unknownAnnotation``
    - -11022
    - The required element is not present in the document annotation.
  * - ``invalidDocumentTemplateFormat``
    - -11023
    - The format of the document template is invalid.
  * - ``insufficientFrameNumber``
    - -11030
    - The frame buffer is not full, and computation is not allowed.
  * - ``backendError``
    - -11039
    - One of our computation backends failed for unknown reasons.
  * - ``inferenceBackendError``
    - -11040
    - The inference backend failed to infer, probably due to inconsistent input.
  * - ``processingUnitUnavailable``
    - -11041
    - The requested processing unit is not available in this build.
  * - ``functionNotImplemented``
    - -11056
    - This function is not implemented.
