result_cc.h File Reference

Defines success/error result codes. More...

#include <stdint.h>
#include "mip_cc/mip_macros_cc.h"

Include dependency graph for result_cc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	mip_cc_result {   MIP_RESULT_SUCCESS = 0 ,   MIP_RESULT_ERROR_UNKNOWN = 1 ,   MIP_RESULT_ERROR_INSUFFICIENT_BUFFER = 2 ,   MIP_RESULT_ERROR_BAD_INPUT = 3 ,   MIP_RESULT_ERROR_FILE_IO_ERROR = 4 ,   MIP_RESULT_ERROR_NETWORK = 5 ,   MIP_RESULT_ERROR_INTERNAL = 6 ,   MIP_RESULT_ERROR_JUSTIFICATION_REQUIRED = 7 ,   MIP_RESULT_ERROR_NOT_SUPPORTED_OPERATION = 8 ,   MIP_RESULT_ERROR_PRIVILEGED_REQUIRED = 9 ,   MIP_RESULT_ERROR_ACCESS_DENIED = 10 ,   MIP_RESULT_ERROR_CONSENT_DENIED = 11 ,   MIP_RESULT_ERROR_NO_PERMISSIONS = 12 ,   MIP_RESULT_ERROR_NO_AUTH_TOKEN = 13 ,   MIP_RESULT_ERROR_SERVICE_DISABLED = 14 ,   MIP_RESULT_ERROR_PROXY_AUTH = 15 ,   MIP_RESULT_ERROR_NO_POLICY = 16 ,   MIP_RESULT_ERROR_OPERATION_CANCELLED = 17 ,   MIP_RESULT_ERROR_ADHOC_PROTECTION_REQUIRED = 18 ,   MIP_RESULT_ERROR_DEPRECATED_API = 19 ,   MIP_RESULT_ERROR_TEMPLATE_NOT_FOUND = 20 ,   MIP_RESULT_ERROR_LABEL_NOT_FOUND = 21 ,   MIP_RESULT_ERROR_LABEL_DISABLED = 22 ,   MIP_RESULT_ERROR_DOUBLE_KEY_DISABLED = 23 ,   MIP_RESULT_ERROR_LICENSE_NOT_REGISTERED = 24 ,   MIP_RESULT_ERROR_CONTENT_FORMAT_NOT_SUPPORTED = 25 ,   MIP_RESULT_ERROR_TEMPLATE_ARCHIVED = 26 ,   MIP_RESULT_ERROR_CUSTOMER_KEY_UNAVAILABLE = 27 }
	API success/failure result. More...

Detailed Description

Defines success/error result codes.

Definition in file result_cc.h.

Enumeration Type Documentation

mip_cc_result

enum mip_cc_result

API success/failure result.

Enumerator
MIP_RESULT_SUCCESS
MIP_RESULT_ERROR_UNKNOWN	Unknown error.
MIP_RESULT_ERROR_INSUFFICIENT_BUFFER	Buffer provided by application is too small.
MIP_RESULT_ERROR_BAD_INPUT	Application passed bad input.
MIP_RESULT_ERROR_FILE_IO_ERROR	General file i/o error.
MIP_RESULT_ERROR_NETWORK	General network error (e.g. unreachable service)
MIP_RESULT_ERROR_INTERNAL	Unexpected internal error.
MIP_RESULT_ERROR_JUSTIFICATION_REQUIRED	Justification should be provided to complete the action on the file.
MIP_RESULT_ERROR_NOT_SUPPORTED_OPERATION	Opeation is not supported.
MIP_RESULT_ERROR_PRIVILEGED_REQUIRED	Cannot override privileged label when with standard method.
MIP_RESULT_ERROR_ACCESS_DENIED	User does not have rights to access the service.
MIP_RESULT_ERROR_CONSENT_DENIED	An operation that required consent from the user was not granted consent.
MIP_RESULT_ERROR_NO_PERMISSIONS	The user could not get access to the content (e.g. no permissions, content revoked)
MIP_RESULT_ERROR_NO_AUTH_TOKEN	The user could not get access to the content due to an empty auth token.
MIP_RESULT_ERROR_SERVICE_DISABLED	The user could not get access to the content due to the service being disabled.
MIP_RESULT_ERROR_PROXY_AUTH	Proxy authentication failed.
MIP_RESULT_ERROR_NO_POLICY	No policy is configured for user/tenant.
MIP_RESULT_ERROR_OPERATION_CANCELLED	Operation cancelled.
MIP_RESULT_ERROR_ADHOC_PROTECTION_REQUIRED	Ad-hoc protection should be set to complete the action on the file.
MIP_RESULT_ERROR_DEPRECATED_API	Caller invoked a deprecated API.
MIP_RESULT_ERROR_TEMPLATE_NOT_FOUND	Template ID is not recognized.
MIP_RESULT_ERROR_LABEL_NOT_FOUND	Label ID is not recognized.
MIP_RESULT_ERROR_LABEL_DISABLED	Label is disabled or inactive.
MIP_RESULT_ERROR_DOUBLE_KEY_DISABLED	The double key feature has not been enabled.
MIP_RESULT_ERROR_LICENSE_NOT_REGISTERED	License not registered for tracking and revocation.
MIP_RESULT_ERROR_CONTENT_FORMAT_NOT_SUPPORTED	Content format is not supported.
MIP_RESULT_ERROR_TEMPLATE_ARCHIVED	Template has been archived and is unavailable for protection.
MIP_RESULT_ERROR_CUSTOMER_KEY_UNAVAILABLE	Bring your own encryption key needed and unavailable.

Definition at line 44 of file result_cc.h.

             {
  MIP_RESULT_SUCCESS = 0,
 
  // MIP C API errors
  MIP_RESULT_ERROR_UNKNOWN = 1,                       /**< Unknown error */
  MIP_RESULT_ERROR_INSUFFICIENT_BUFFER = 2,           /**< Buffer provided by application is too small */
 
  // MIP C++ exceptions
  MIP_RESULT_ERROR_BAD_INPUT = 3,                     /**< Application passed bad input */
  MIP_RESULT_ERROR_FILE_IO_ERROR = 4,                 /**< General file i/o error */
  MIP_RESULT_ERROR_NETWORK = 5,                       /**< General network error (e.g. unreachable service) */
  MIP_RESULT_ERROR_INTERNAL = 6,                      /**< Unexpected internal error */
  MIP_RESULT_ERROR_JUSTIFICATION_REQUIRED = 7,        /**< Justification should be provided to complete the action on the file. */
  MIP_RESULT_ERROR_NOT_SUPPORTED_OPERATION = 8,       /**< Opeation is not supported */
  MIP_RESULT_ERROR_PRIVILEGED_REQUIRED = 9,           /**< Cannot override privileged label when with standard method */
  MIP_RESULT_ERROR_ACCESS_DENIED = 10,                /**< User does not have rights to access the service */
  MIP_RESULT_ERROR_CONSENT_DENIED = 11,               /**< An operation that required consent from the user was not granted consent */
  MIP_RESULT_ERROR_NO_PERMISSIONS = 12,               /**< The user could not get access to the content (e.g. no permissions, content revoked) */
  MIP_RESULT_ERROR_NO_AUTH_TOKEN = 13,                /**< The user could not get access to the content due to an empty auth token */
  MIP_RESULT_ERROR_SERVICE_DISABLED = 14,             /**< The user could not get access to the content due to the service being disabled */
  MIP_RESULT_ERROR_PROXY_AUTH = 15,                   /**< Proxy authentication failed */
  MIP_RESULT_ERROR_NO_POLICY = 16,                    /**< No policy is configured for user/tenant */
  MIP_RESULT_ERROR_OPERATION_CANCELLED = 17,          /**< Operation cancelled */
  MIP_RESULT_ERROR_ADHOC_PROTECTION_REQUIRED = 18,    /**< Ad-hoc protection should be set to complete the action on the file */
  MIP_RESULT_ERROR_DEPRECATED_API = 19,               /**< Caller invoked a deprecated API */
  MIP_RESULT_ERROR_TEMPLATE_NOT_FOUND = 20,           /**< Template ID is not recognized */
  MIP_RESULT_ERROR_LABEL_NOT_FOUND = 21,              /**< Label ID is not recognized */
  MIP_RESULT_ERROR_LABEL_DISABLED = 22,               /**< Label is disabled or inactive */
  MIP_RESULT_ERROR_DOUBLE_KEY_DISABLED = 23,          /**< The double key feature has not been enabled */
  MIP_RESULT_ERROR_LICENSE_NOT_REGISTERED = 24,       /**< License not registered for tracking and revocation */
  MIP_RESULT_ERROR_CONTENT_FORMAT_NOT_SUPPORTED = 25, /**< Content format is not supported */
  MIP_RESULT_ERROR_TEMPLATE_ARCHIVED = 26,            /**< Template has been archived and is unavailable for protection */
  MIP_RESULT_ERROR_CUSTOMER_KEY_UNAVAILABLE = 27,     /**< Bring your own encryption key needed and unavailable */
} mip_cc_result;