action_result_cc.h File Reference

A file containing definition of action result type. More...

#include <stdint.h>
#include "mip_cc/common_types_cc.h"
#include "mip_cc/error_cc.h"
#include "mip_cc/result_cc.h"
#include "mip_cc/upe/action_cc.h"

Include dependency graph for action_result_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_action_result

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_ActionResult_GetActions(const mip_cc_action_result actionResult
	Get actions that compose an action result.
	MIP_CC_API (void) MIP_CC_ReleaseActionResult(mip_cc_action_result actionResult)
	Release resources associated with an action result.

Variables
mip_cc_action **	actions
mip_cc_action int64_t *	count
mip_cc_action int64_t mip_cc_error *	errorInfo

Detailed Description

A file containing definition of action result type.

Definition in file action_result_cc.h.

Typedef Documentation

mip_cc_action_result

typedef mip_cc_handle* mip_cc_action_result

Definition at line 44 of file action_result_cc.h.

Function Documentation

MIP_CC_API() [1/2]

MIP_CC_API

(

mip_cc_result

)

const

Get actions that compose an action result.

Parameters

actionResult	Source action result
actions	[Output] Array of actions, memory owned by mip_cc_action_result object
count	[Output] Number of key/value pairs
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

The memory for 'actions' is owned by the mip_cc_action_result object, so it should not be freed independently

MIP_CC_API() [2/2]

MIP_CC_API

(

void

)

Release resources associated with an action result.

Parameters

actionResult

Action result to be released

Variable Documentation

actions

mip_cc_action** actions

Definition at line 60 of file action_result_cc.h.

count

mip_cc_action int64_t* count

Definition at line 61 of file action_result_cc.h.

errorInfo

mip_cc_action int64_t mip_cc_error* errorInfo

Definition at line 62 of file action_result_cc.h.