add_watermark_action_cc.h File Reference

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

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

Include dependency graph for add_watermark_action_cc.h:

Go to the source code of this file.

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_AddWatermarkAction_GetUIElementNameSize(const mip_cc_action action
	Gets size of buffer required to store an "add watermark" 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
char *	colorBuffer
char const int64_t	colorBufferSize
int64_t *	colorSize
int64_t mip_cc_error *	errorInfo
int32_t *	fontSize
mip_cc_watermark_layout *	layout
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 watermark" label policy action.

Definition in file add_watermark_action_cc.h.

Function Documentation

MIP_CC_API()

MIP_CC_API

(

mip_cc_result

)

const

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

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

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

Gets the integer font size.

Gets an "add watermark" action's font name.

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

Gets an "add watermark" action's text.

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

Gets the watermark layout.

Gets an "add watermark" action's UI element name.

Parameters

action	"add watermark" 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 watermark" 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 watermark" action
layout	[Output] Watermark layout
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Parameters

action	"add watermark" action
textSize	[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 watermark" 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 watermark" 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 watermark" 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 watermark" 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 watermark" 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 watermark" 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.

Variable Documentation

actualColorSize

char const int64_t int64_t* actualColorSize

Definition at line 204 of file add_watermark_action_cc.h.

actualNameSize

char const int64_t int64_t* actualNameSize

Definition at line 71 of file add_watermark_action_cc.h.

actualTextSize

char const int64_t int64_t* actualTextSize

Definition at line 120 of file add_watermark_action_cc.h.

colorBuffer

char* colorBuffer

Definition at line 202 of file add_watermark_action_cc.h.

colorBufferSize

char const int64_t colorBufferSize

Definition at line 203 of file add_watermark_action_cc.h.

colorSize

int64_t* colorSize

Definition at line 183 of file add_watermark_action_cc.h.

errorInfo

char const int64_t int64_t mip_cc_error* errorInfo

Definition at line 51 of file add_watermark_action_cc.h.

fontSize

int32_t* fontSize

Definition at line 169 of file add_watermark_action_cc.h.

layout

mip_cc_watermark_layout* layout

Definition at line 85 of file add_watermark_action_cc.h.

nameBuffer

char* nameBuffer

Definition at line 69 of file add_watermark_action_cc.h.

nameBufferSize

char const int64_t nameBufferSize

Definition at line 70 of file add_watermark_action_cc.h.

nameSize

int64_t* nameSize

Definition at line 50 of file add_watermark_action_cc.h.

textBuffer

char* textBuffer

Definition at line 118 of file add_watermark_action_cc.h.

textBufferSize

char const int64_t textBufferSize

Definition at line 119 of file add_watermark_action_cc.h.

textSize

int64_t* textSize

Definition at line 99 of file add_watermark_action_cc.h.