Contains C API definitions for "add content header" label policy action. More...

#include "mip_cc/error_cc.h"
#include "mip_cc/upe/action_cc.h"

Include dependency graph for add_content_header_action_cc.h:

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_AddContentHeaderAction_GetUIElementNameSize(const mip_cc_action action
	Gets size of buffer required to store an "add content header" action's UI element name.

Variables
char const int64_t int64_t *	actualColorSize

char const int64_t int64_t *	actualNameSize

char const int64_t int64_t *	actualTextSize

mip_cc_content_mark_alignment *	alignment

char *	colorBuffer

char const int64_t	colorBufferSize

int64_t *	colorSize

int64_t mip_cc_error *	errorInfo

int32_t *	fontSize

int32_t *	marginSize

char *	nameBuffer

char const int64_t	nameBufferSize

int64_t *	nameSize

char *	textBuffer

char const int64_t	textBufferSize

int64_t *	textSize

Detailed Description

Contains C API definitions for "add content header" label policy action.

Definition in file add_content_header_action_cc.h.

Function Documentation

◆ MIP_CC_API()

MIP_CC_API ( mip_cc_result ) const

Gets size of buffer required to store an "add content header" action's UI element name.

Gets the margin size.

Gets the alignment.

Gets an "add content header" action's font color (for example, "#000000")

Gets size of buffer required to store an "add content header" action's font color.

Gets the integer font size.

Gets an "add content header" action's font name.

Gets size of buffer required to store an "add content header" action's font name.

Gets an "add content header" action's text.

Gets size of buffer required to store an "add content header" action's text.

Gets an "add content header" action's UI element name.

Parameters

action	"add content header" action
nameSize	[Output] Size of buffer to hold UI element name (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

action	"add content header" action
nameBuffer	[Output] Buffer the UI element 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

action	"add content header" action
nameSize	[Output] Size of buffer to hold text (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

action	"add content header" action
textBuffer	[Output] Buffer the text will be copied into.
textBufferSize	Size (in number of chars) of the textBuffer.
actualTextSize	[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 textBuffer is null or insufficient, MIP_RESULT_ERROR_INSUFFICIENT_BUFFER will be returned and actualTextSize will be set to the minimum required buffer size.

Parameters

action	"add content header" action
nameSize	[Output] Size of buffer to hold font name (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

action	"add content header" action
nameBuffer	[Output] Buffer the font 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

action	"add content header" action
fontSize	[Output] Font size
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

action	"add content header" action
colorSize	[Output] Size of buffer to hold font color (in number of chars)
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns: Result code indicating success or failure

Parameters

action	"add content header" action
colorBuffer	[Output] Buffer the font color will be copied into.
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