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"

Include dependency graph for label_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_label

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

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

Detailed Description

Contains C API definitions for label.

Definition in file label_cc.h.

Typedef Documentation

mip_cc_label

typedef mip_cc_handle* mip_cc_label

Definition at line 42 of file label_cc.h.

Function Documentation

MIP_CC_API() [1/2]

MIP_CC_API

(

mip_cc_result

)

const

Gets label ID.

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.

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.

Higher value means more sensitive.

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. Inactivte 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

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

Definition at line 317 of file label_cc.h.

actualColorSize

char const int64_t int64_t* actualColorSize

Definition at line 167 of file label_cc.h.

actualDescriptionSize

char const int64_t int64_t* actualDescriptionSize

Definition at line 132 of file label_cc.h.

actualNameSize

char const int64_t int64_t* actualNameSize

Definition at line 97 of file label_cc.h.

actualTooltipSize

char const int64_t int64_t * actualTooltipSize

Definition at line 216 of file label_cc.h.

childrenBuffer

mip_cc_label* childrenBuffer

Definition at line 315 of file label_cc.h.

childrenBufferSize

mip_cc_label const int64_t childrenBufferSize

Definition at line 316 of file label_cc.h.

childrenSize

int64_t* childrenSize

Definition at line 295 of file label_cc.h.

colorBuffer

char* colorBuffer

Definition at line 165 of file label_cc.h.

colorBufferSize

char const int64_t colorBufferSize

Definition at line 166 of file label_cc.h.

colorSize

int64_t* colorSize

Definition at line 146 of file label_cc.h.

descriptionBuffer

char* descriptionBuffer

Definition at line 130 of file label_cc.h.

descriptionBufferSize

char const int64_t descriptionBufferSize

Definition at line 131 of file label_cc.h.

descriptionSize

int64_t* descriptionSize

Definition at line 111 of file label_cc.h.

errorInfo

mip_cc_dictionary mip_cc_error* errorInfo

Definition at line 63 of file label_cc.h.

isActive

bool* isActive

Definition at line 267 of file label_cc.h.

labelId

mip_cc_guid* labelId

Definition at line 62 of file label_cc.h.

nameBuffer

char* nameBuffer

Definition at line 95 of file label_cc.h.

nameBufferSize

char const int64_t nameBufferSize

Definition at line 96 of file label_cc.h.

nameSize

int64_t* nameSize

Definition at line 76 of file label_cc.h.

parent

mip_cc_label* parent

Definition at line 281 of file label_cc.h.

sensitivity

int32_t* sensitivity

Definition at line 181 of file label_cc.h.

settings

mip_cc_dictionary* settings

Definition at line 333 of file label_cc.h.

tooltipBuffer

char * tooltipBuffer

Definition at line 214 of file label_cc.h.

tooltipBufferSize

char const int64_t tooltipBufferSize

Definition at line 215 of file label_cc.h.

tooltipSize

int64_t * tooltipSize

Definition at line 195 of file label_cc.h.