policy_handler_cc.h File Reference

Contains C API definitions for policy handler. More...

#include <stdint.h>
#include "mip_cc/common_types_cc.h"
#include "mip_cc/error_cc.h"
#include "mip_cc/result_cc.h"
#include "mip_cc/upe/action_result_cc.h"
#include "mip_cc/upe/application_action_state_cc.h"
#include "mip_cc/upe/content_label_cc.h"
#include "mip_cc/upe/document_state_cc.h"

Include dependency graph for policy_handler_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_policy_handler

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_PolicyHandler_GetSensitivityLabel(const mip_cc_policy_handler handler
	Gets a document's current label.
	MIP_CC_API (void) MIP_CC_ReleasePolicyHandler(mip_cc_policy_handler handler)
	Release resources associated with a policy handler.

Variables
const mip_cc_document_state const mip_cc_application_action_state const void mip_cc_action_result *	actionResult
const mip_cc_document_state const mip_cc_application_action_state *	applicationState
const mip_cc_document_state const void mip_cc_content_label *	contentLabel
const mip_cc_document_state const void *	context
const mip_cc_document_state *	documentState
const mip_cc_document_state const void mip_cc_content_label mip_cc_error *	errorInfo

Detailed Description

Contains C API definitions for policy handler.

Definition in file policy_handler_cc.h.

Typedef Documentation

mip_cc_policy_handler

typedef mip_cc_handle* mip_cc_policy_handler

Definition at line 46 of file policy_handler_cc.h.

Function Documentation

MIP_CC_API() [1/2]

MIP_CC_API

(

mip_cc_result

)

const

Gets a document's current label.

Called by application after computed actions have been applied and data committed to disk.

Executes policy rules based on the provided state and determines corresponding actions.

Parameters

handler	Policy handler
documentState	Document state
context	Application context opaquely forwarded to any callbacks
contentLabel	Label currently applied to a document
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

handler	Policy handler
documentState	Document state
applicationState	Application action state
context	Application context opaquely forwarded to any callbacks
actionResult	[Output] Actions that should be taken by application, memory owned by caller
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

The 'actionResult' variable must be released by the caller by calling MIP_CC_ReleaseActionResult

Parameters

handler	Policy handler
documentState	Document state
applicationState	Application action state
context	Application context opaquely forwarded to any callbacks
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

A call to this function is necessary to transmit complete label audit data.

MIP_CC_API() [2/2]

MIP_CC_API

(

void

)

Release resources associated with a policy handler.

Parameters

handler

Policy handler to release

Variable Documentation

actionResult

const mip_cc_document_state const mip_cc_application_action_state const void mip_cc_action_result* actionResult

Definition at line 92 of file policy_handler_cc.h.

applicationState

const mip_cc_document_state const mip_cc_application_action_state * applicationState

Definition at line 90 of file policy_handler_cc.h.

contentLabel

const mip_cc_document_state const void mip_cc_content_label* contentLabel

Definition at line 70 of file policy_handler_cc.h.

context

const mip_cc_document_state const mip_cc_application_action_state const void* context

Definition at line 69 of file policy_handler_cc.h.

documentState

const mip_cc_document_state * documentState

Definition at line 68 of file policy_handler_cc.h.

errorInfo

const mip_cc_document_state const mip_cc_application_action_state const void mip_cc_error* errorInfo

Definition at line 71 of file policy_handler_cc.h.