document_state_cc.h File Reference

Describes document state when performing a label-related operation. More...

#include "mip_cc/common_types_cc.h"
#include "mip_cc/dictionary_cc.h"
#include "mip_cc/protection_descriptor_cc.h"
#include "mip_cc/upe/metadata_dictionary_cc.h"

Include dependency graph for document_state_cc.h:

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

Go to the source code of this file.

Data Structures
struct	mip_cc_document_state
	Represents the current state of a label-aware document. More...

Enumerations
enum	mip_cc_data_state {   MIP_DATA_STATE_REST = 0 ,   MIP_DATA_STATE_MOTION = 1 ,   MIP_DATA_STATE_USE = 2 }
	Defines the state of the data as an application is acting upon it. More...

Functions
	MIP_CC_CALLBACK (mip_cc_metadata_callback, void, const char **, const int64_t, const char **, const int64_t, const void *, mip_cc_metadata_dictionary *)
	Callback function definition for retrieving document metatdata, filtered by name/prefix.

Detailed Description

Describes document state when performing a label-related operation.

Definition in file document_state_cc.h.

Enumeration Type Documentation

mip_cc_data_state

enum mip_cc_data_state

Defines the state of the data as an application is acting upon it.

Enumerator
MIP_DATA_STATE_REST	Inactive data stored physically in databases/file/warehouses.
MIP_DATA_STATE_MOTION	Data traversing a network or temporarily residing in computer memory to be read or updated.
MIP_DATA_STATE_USE	Active data under constant change stored physically in databases/file/warehouses etc.

Definition at line 44 of file document_state_cc.h.

             {
  MIP_DATA_STATE_REST = 0,   /**< Inactive data stored physically in databases/file/warehouses */
  MIP_DATA_STATE_MOTION = 1, /**< Data traversing a network or temporarily residing in computer memory to be read or updated */
  MIP_DATA_STATE_USE = 2,    /**< Active data under constant change stored physically in databases/file/warehouses etc */
} mip_cc_data_state;

Function Documentation

MIP_CC_CALLBACK()

MIP_CC_CALLBACK	(	mip_cc_metadata_callback	,
		void	,
		const char **	,
		const int64_t	,
		const char **	,
		const int64_t	,
		const void *	,
		mip_cc_metadata_dictionary *	)

Callback function definition for retrieving document metatdata, filtered by name/prefix.

Parameters

names	Array of metadata key names to include in result
namesSize	Number of values in 'names' array
namePrefixes	Array of metadata key name prefixes to include in result
namePrefixesSize	Number of values in 'namesPrefixes' array
context	Application context opaquely passed from API call to callback
metadata	[Output] Dictionary of metadata key/values, created by client application. This dictionary will be released by MIP.