custom_action_cc.h File Reference

Contains C API definitions for custom label policy action. More...

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

Include dependency graph for custom_action_cc.h:

Go to the source code of this file.

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_CustomAction_GetNameSize(const mip_cc_action action
	Gets size of buffer required to store a "custom" action's name.

Variables
char const int64_t int64_t *	actualNameSize
int64_t mip_cc_error *	errorInfo
char *	nameBuffer
char const int64_t	nameBufferSize
int64_t *	nameSize
mip_cc_dictionary *	properties

Detailed Description

Contains C API definitions for custom label policy action.

Definition in file custom_action_cc.h.

Function Documentation

MIP_CC_API()

MIP_CC_API

(

mip_cc_result

)

const

Gets size of buffer required to store a "custom" action's name.

Gets a "custom" action's properties.

Gets a "custom" action's name.

Parameters

action	"custom" action
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

action	"custom" action
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

action	"custom" action
properties	[Output] Dictionary of properties, memory owned by caller
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

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

Variable Documentation

actualNameSize

char const int64_t int64_t* actualNameSize

Definition at line 72 of file custom_action_cc.h.

errorInfo

mip_cc_dictionary mip_cc_error* errorInfo

Definition at line 52 of file custom_action_cc.h.

nameBuffer

char* nameBuffer

Definition at line 70 of file custom_action_cc.h.

nameBufferSize

char const int64_t nameBufferSize

Definition at line 71 of file custom_action_cc.h.

nameSize

int64_t* nameSize

Definition at line 51 of file custom_action_cc.h.

properties

mip_cc_dictionary* properties

Definition at line 88 of file custom_action_cc.h.