.. _ChapterErrorCodes:

***********
Error Codes
***********

Please see the API chapter for specific details on what each error means from any given function.

Error Codes
===========

.. csv-table::
  :header: "Error Code", "Description"
  :widths: 25, 75
  
  "NULL_FACE_CAPTURE_OBJ", "The Face Capture object was NULL."
  "TRIAL_EXPIRATION_PASSED", "The trial period for Face Capture has expired.  Please contact Aware."
  "OUT_OF_MEMORY", "Failed to allocate sufficient memory for this function."
  "INITIALIZATION_FAILED", "Could not initialize Face Capture or a required component."
  "INVALID_WORKFLOW", "The Workflow object was invalid."
  "UNKNOWN_WORKFLOW", "No Workflow exists with the given name."
  "WORKFLOW_IN_USE", "Workflows cannot be modified while a capture session is in progress."
  "INVALID_PACKAGE_TYPE", "An invalid package type was specified."
  "INVALID_WORKFLOW_PROPERTY", "An invalid workflow property was specified."
  "WORKFLOW_PROPERTY_TYPE_MISMATCH", "The specified value is the wrong type for the specified property."
  "INVALID_PROPERTY_VALUE", "The specified value is not valid for the specified property."
  "INVALID_CAMERA", "The Camera object was invalid."
  "UNKNOWN_CAMERA", "No camera exists with the given name."
  "CAMERA_IN_USE", "Cameras cannot be modified while a capture session is in progress."
  "CAMERA_INITIALIZATION", "Camera could not be initialized."
  "NO_INITIALIZABLE_CAMERAS", "No cameras were detected."
  "INVALID_CAMERA_POSITION", "The camera position specified was an invalid value."
  "INVALID_CAMERA_ORIENTATION", "The camera orientation specified was an invalid value."
  "INVALID_CAPTURE_STATE", "The Capture State object was invalid."
  "NO_FRAME_AVAILABLE", "No frame data is available from the capture state object."
  "CAPTURE_IN_PROGRESS", "A capture session is already in progress."
  "CAPTURE_SESSION_UNAVAILABLE", "The previous capture session for the specified Workflow was aborted."
  "NO_CAPTURE_PROFILE", "No capture profile was specified by the Workflow."
  "INVALID_CAPTURE_PROFILE", "The capture profile set in the Workflow was invalid."
  "WORKFLOW_INCOMPATIBLE_WITH_CAMERA", "The selected Camera and Workflow are incompatible.  Please see the Workflow description for usable camera criteria."
  "INVALID_ENCRYPTION_TYPE", "An invalid encryption type was specified."
  "INVALID_ENCRYPTION_PUBLIC_KEY", "The encryption public key specified was invalid or malformed."