label_cc.h File Reference

Contains C API definitions for label. More...

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

Go to the source code of this file.

Typedefs
typedef mip_cc_handle *	mip_cc_label

Functions
	MIP_CC_API (void) MIP_CC_ReleaseLabel(mip_cc_label label)
	Release resources associated with a label.
	MIP_CC_API (mip_cc_result) MIP_CC_Label_GetId(const mip_cc_label label
	Gets label ID.

Variables
mip_cc_guid *	labelId
mip_cc_guid mip_cc_error *	errorInfo
int64_t *	nameSize
char *	nameBuffer
char const int64_t	nameBufferSize
char const int64_t int64_t *	actualNameSize
int64_t *	descriptionSize
char *	descriptionBuffer
char const int64_t	descriptionBufferSize
char const int64_t int64_t *	actualDescriptionSize
int64_t *	colorSize
char *	colorBuffer
char const int64_t	colorBufferSize
char const int64_t int64_t *	actualColorSize
int32_t *	sensitivity
int64_t *	tooltipSize
char *	tooltipBuffer
char const int64_t	tooltipBufferSize
char const int64_t int64_t *	actualTooltipSize
bool *	isActive
mip_cc_label *	parent
int64_t *	childrenSize
mip_cc_label *	childrenBuffer
mip_cc_label const int64_t	childrenBufferSize
mip_cc_label const int64_t int64_t *	actualChildrenSize
mip_cc_dictionary *	settings
int64_t *	doubleKeyUrlSize
char *	doubleKeyUrlBuffer
char const int64_t	doubleKeyUrlBufferSize
char const int64_t int64_t *	actualDoubleKeyUrlSize
bool *	hasRightsManagementPolicy
bool *	hasDoNotForwardProtection
bool *	hasEncryptOnlyProtection
bool *	hasAdhocProtection

Detailed Description

Contains C API definitions for label.

Typedef Documentation

mip_cc_label

typedef mip_cc_handle* mip_cc_label

Function Documentation

MIP_CC_API() [1/2]

MIP_CC_API

(

mip_cc_result

)

const

Gets label ID.

Gets whether the label is associated with a policy that applies adhoc protection.

Gets whether the label is associated with a policy that applies encrypt only protection.

Gets whether the label is associated with a policy that applies do not forward protection.

Gets whether the label is associated with a policy that applies protection.

Gets label Double Key URL.

Gets size of buffer required to store the label's Double Key URL.

Gets policy-defined custom settings of a label.

Gets the children labels.

Gets the number of children labels.

Gets the parent label, if any.

Gets whether or not a label is active.

Gets label auto-classification tooltip.

Gets size of buffer required to store auto-classification tooltip.

Gets label tooltip.

Gets size of buffer required to store tooltip.

Gets sensitivity level of label. Higher value means more sensitive.

Gets label color.

Gets size of buffer required to store color.

Gets label description.

Gets size of buffer required to store description.

Gets label name.

Gets size of buffer required to store name.

Parameters

label	Label
labelId	[Output] Label ID
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

label	Label
nameSize	[Output] Size of buffer to hold name (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

label	Label
nameBuffer	[Output] Buffer the name will be copied into.
nameBufferSize	Size (in number of chars) of the nameBuffer.
actualNameSize	[Output] Number of chars written to the buffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If nameBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualNameSize will be set to the minimum required buffer size.

Parameters

label	Label
descriptionSize	[Output] Size of buffer to hold description (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

label	Label
descriptionBuffer	[Output] Buffer the description will be copied into.
descriptionBufferSize	Size (in number of chars) of the descriptionBuffer.
actualDescriptionSize	[Output] Number of chars written to the buffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If descriptionBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualDescriptionSize will be set to the minimum required buffer size.

Parameters

label	Label
colorSize	[Output] Size of buffer to hold color (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

label	Label
colorBuffer	[Output] Buffer the color will be copied into (in #RRGGBB format).
colorBufferSize	Size (in number of chars) of the colorBuffer.
actualColorSize	[Output] Number of chars written to the buffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If colorBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualColorSize will be set to the minimum required buffer size.

Parameters

label	Label
sensitivity	[Output] Sensitivity level
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

label	Label
tooltipSize	[Output] Size of buffer to hold tooltip (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

label	Label
tooltipBuffer	[Output] Buffer the tooltip will be copied into.
tooltipBufferSize	Size (in number of chars) of the tooltipBuffer.
actualTooltipSize	[Output] Number of chars written to the buffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If tooltipBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualTooltipSize will be set to the minimum required buffer size.

Parameters

label	Label
isActive	[Output] Whether or not a label is considered active.
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

Only active labels can be applied. Inactive labels cannot be applied and are used for display purposes only.

Parameters

label	Label
parent	[Output] Parent label, if any, else null
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

label	Label
childrenSize	[Output] Number of children
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

label	Label
childrenBuffer	[Output] Buffer the children labels will be copied into. Children labels are owned by the caller and must be released with MIP_CC_ReleaseLabel.
childrenBufferSize	Size (in number of labels) of the childrenBuffer.
actualChildrenSize	[Output] Number of children labels written to the buffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If childrenBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualChildrenSize will be set to the minimum required buffer size

Parameters

label	Label
settings	[Output] Dictionary of settings, owned by the caller
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

The 'settings' variable must be released by the caller by calling MIP_CC_ReleaseDictionary

Parameters

label	Label
doubleKeyUrlSize	[Output] Size of buffer to hold doubleKeyUrl (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

label	Label
doubleKeyUrlBuffer	[Output] Buffer the doubleKeyUrl will be copied into.
doubleKeyUrlBufferSize	Size (in number of chars) of the doubleKeyUrlBuffer.
actualDoubleKeyUrlSize	[Output] (Optional) Number of chars written to the buffer
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

If doubleKeyUrlBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualDoubleKeyUrlSize will be set to the minimum required buffer size.

Parameters

label	Label
hasRightsManagementPolicy	[Output] Whether or not a label has a rights management policy.
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

label	Label
hasDoNotForwardProtection	[Output] Whether or not a label has do not forward protection.
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

label	Label
hasEncryptOnlyProtection	[Output] Whether or not a label has encrypt only protection.
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

label	Label
hasAdhocProtection	[Output] Whether or not a label has adhoc protection.
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

MIP_CC_API() [2/2]

MIP_CC_API

(

void

)

Release resources associated with a label.

Parameters

label

Label to be released

Variable Documentation

actualChildrenSize

mip_cc_label const int64_t int64_t* actualChildrenSize

actualColorSize

char const int64_t int64_t* actualColorSize

actualDescriptionSize

char const int64_t int64_t* actualDescriptionSize

actualDoubleKeyUrlSize

char const int64_t int64_t* actualDoubleKeyUrlSize

actualNameSize

char const int64_t int64_t* actualNameSize

actualTooltipSize

char const int64_t int64_t * actualTooltipSize

childrenBuffer

mip_cc_label* childrenBuffer

childrenBufferSize

mip_cc_label const int64_t childrenBufferSize

childrenSize

int64_t* childrenSize

colorBuffer

char* colorBuffer

colorBufferSize

char const int64_t colorBufferSize

colorSize

int64_t* colorSize

descriptionBuffer

char* descriptionBuffer

descriptionBufferSize

char const int64_t descriptionBufferSize

descriptionSize

int64_t* descriptionSize

doubleKeyUrlBuffer

char* doubleKeyUrlBuffer

doubleKeyUrlBufferSize

char const int64_t doubleKeyUrlBufferSize

doubleKeyUrlSize

int64_t* doubleKeyUrlSize

errorInfo

bool mip_cc_error* errorInfo

hasAdhocProtection

bool* hasAdhocProtection

hasDoNotForwardProtection

bool* hasDoNotForwardProtection

hasEncryptOnlyProtection

bool* hasEncryptOnlyProtection

hasRightsManagementPolicy

bool* hasRightsManagementPolicy

isActive

bool* isActive

labelId

mip_cc_guid* labelId

nameBuffer

char* nameBuffer

nameBufferSize

char const int64_t nameBufferSize

nameSize

int64_t* nameSize

parent

mip_cc_label* parent

sensitivity

int32_t* sensitivity

settings

mip_cc_dictionary* settings

tooltipBuffer

char * tooltipBuffer

tooltipBufferSize

char const int64_t tooltipBufferSize

tooltipSize

int64_t * tooltipSize