action_cc.h File Reference

Contains C API definitions for label policy actions. More...

#include "mip_cc/common_types_cc.h"
#include "mip_cc/error_cc.h"
#include "mip_cc/result_cc.h"

Include dependency graph for action_cc.h:

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

Go to the source code of this file.

Typedefs
typedef mip_cc_handle *	mip_cc_action

Enumerations
enum	mip_cc_action_type {   MIP_ACTION_TYPE_ADD_CONTENT_FOOTER = 1 << 0 ,   MIP_ACTION_TYPE_ADD_CONTENT_HEADER = 1 << 1 ,   MIP_ACTION_TYPE_ADD_WATERMARK = 1 << 2 ,   MIP_ACTION_TYPE_CUSTOM = 1 << 3 ,   MIP_ACTION_TYPE_JUSTIFY = 1 << 4 ,   MIP_ACTION_TYPE_METADATA = 1 << 5 ,   MIP_ACTION_TYPE_PROTECT_ADHOC = 1 << 6 ,   MIP_ACTION_TYPE_PROTECT_BY_TEMPLATE = 1 << 7 ,   MIP_ACTION_TYPE_PROTECT_DO_NOT_FORWARD = 1 << 8 ,   MIP_ACTION_TYPE_REMOVE_CONTENT_FOOTER = 1 << 9 ,   MIP_ACTION_TYPE_REMOVE_CONTENT_HEADER = 1 << 10 ,   MIP_ACTION_TYPE_REMOVE_PROTECTION = 1 << 11 ,   MIP_ACTION_TYPE_REMOVE_WATERMARK = 1 << 12 ,   MIP_ACTION_TYPE_APPLY_LABEL = 1 << 13 ,   MIP_ACTION_TYPE_RECOMMEND_LABEL = 1 << 14 ,   MIP_ACTION_TYPE_PROTECT_ADHOC_DK = 1 << 15 ,   MIP_ACTION_TYPE_PROTECT_DO_NOT_FORWARD_DK = 1 << 17 ,   MIP_ACTION_TYPE_PROTECT_BY_ENCRYPT_ONLY = 1 << 18 }
	Action type bit mask. More...

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_Action_GetType(const mip_cc_action action
	Gets an action's type.

Variables
mip_cc_action_type *	actionType
mip_cc_action_type mip_cc_error *	errorInfo
mip_cc_guid *	id

Detailed Description

Contains C API definitions for label policy actions.

Definition in file action_cc.h.

Typedef Documentation

mip_cc_action

typedef mip_cc_handle* mip_cc_action

Definition at line 40 of file action_cc.h.

Enumeration Type Documentation

mip_cc_action_type

enum mip_cc_action_type

Action type bit mask.

Enumerator
MIP_ACTION_TYPE_ADD_CONTENT_FOOTER	Add a content footer to the document action type.
MIP_ACTION_TYPE_ADD_CONTENT_HEADER	Add a content header to the document action type.
MIP_ACTION_TYPE_ADD_WATERMARK	Add a water mark to the entire document action type.
MIP_ACTION_TYPE_CUSTOM	A custom defined action type.
MIP_ACTION_TYPE_JUSTIFY	A justify action type.
MIP_ACTION_TYPE_METADATA	A Meta data change action type.
MIP_ACTION_TYPE_PROTECT_ADHOC	A protect by adhoc policy action type.
MIP_ACTION_TYPE_PROTECT_BY_TEMPLATE	A protect by template action type.
MIP_ACTION_TYPE_PROTECT_DO_NOT_FORWARD	A protect by do not forward action type.
MIP_ACTION_TYPE_REMOVE_CONTENT_FOOTER	Remove content footer action type.
MIP_ACTION_TYPE_REMOVE_CONTENT_HEADER	Remove content header action type.
MIP_ACTION_TYPE_REMOVE_PROTECTION	Remove protection action type.
MIP_ACTION_TYPE_REMOVE_WATERMARK	Remove watermarking action type.
MIP_ACTION_TYPE_APPLY_LABEL	Apply label action type.
MIP_ACTION_TYPE_RECOMMEND_LABEL	Recommend label action type.
MIP_ACTION_TYPE_PROTECT_ADHOC_DK	A protect by adhoc policy action type.
MIP_ACTION_TYPE_PROTECT_DO_NOT_FORWARD_DK	A protect by do not forward action type.
MIP_ACTION_TYPE_PROTECT_BY_ENCRYPT_ONLY	A protect by encryption action type.

Definition at line 45 of file action_cc.h.

             {
  MIP_ACTION_TYPE_ADD_CONTENT_FOOTER = 1 << 0,        /**< Add a content footer to the document action type.*/
  MIP_ACTION_TYPE_ADD_CONTENT_HEADER = 1 << 1,        /**< Add a content header to the document action type.*/
  MIP_ACTION_TYPE_ADD_WATERMARK = 1 << 2,             /**< Add a water mark to the entire document action type.*/
  MIP_ACTION_TYPE_CUSTOM = 1 << 3,                    /**< A custom defined action type.*/
  MIP_ACTION_TYPE_JUSTIFY = 1 << 4,                   /**< A justify action type.*/
  MIP_ACTION_TYPE_METADATA = 1 << 5,                  /**< A Meta data change action type.*/
  MIP_ACTION_TYPE_PROTECT_ADHOC = 1 << 6,             /**< A protect by adhoc policy action type.*/
  MIP_ACTION_TYPE_PROTECT_BY_TEMPLATE = 1 << 7,       /**< A protect by template action type.*/
  MIP_ACTION_TYPE_PROTECT_DO_NOT_FORWARD = 1 << 8,    /**< A protect by do not forward action type.*/
  MIP_ACTION_TYPE_REMOVE_CONTENT_FOOTER = 1 << 9,     /**< Remove content footer action type.*/
  MIP_ACTION_TYPE_REMOVE_CONTENT_HEADER = 1 << 10,    /**< Remove content header action type.*/
  MIP_ACTION_TYPE_REMOVE_PROTECTION = 1 << 11,        /**< Remove protection action type.*/
  MIP_ACTION_TYPE_REMOVE_WATERMARK = 1 << 12,         /**< Remove watermarking action type.*/
  MIP_ACTION_TYPE_APPLY_LABEL = 1 << 13,              /**< Apply label action type.*/
  MIP_ACTION_TYPE_RECOMMEND_LABEL = 1 << 14,          /**< Recommend label action type.*/
  MIP_ACTION_TYPE_PROTECT_ADHOC_DK = 1 << 15,         /**< A protect by adhoc policy action type.*/
  // Reserved
  MIP_ACTION_TYPE_PROTECT_DO_NOT_FORWARD_DK = 1 << 17,/**< A protect by do not forward action type.*/
  MIP_ACTION_TYPE_PROTECT_BY_ENCRYPT_ONLY = 1 << 18,  /**< A protect by encryption action type.*/
} mip_cc_action_type;

Function Documentation

MIP_CC_API()

MIP_CC_API

(

mip_cc_result

)

const

Gets an action's type.

Gets an action's ID.

Parameters

action	Action
actionType	[Output] Type of action
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

action	Action
id	[Output] Unique action ID
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Variable Documentation

actionType

mip_cc_action_type* actionType

Definition at line 78 of file action_cc.h.

errorInfo

mip_cc_guid mip_cc_error* errorInfo

Definition at line 79 of file action_cc.h.

id

mip_cc_guid* id

Definition at line 92 of file action_cc.h.