metadata_action_cc.h File Reference

Contains C API definitions for "metadata" label policy action. More...

#include "mip_cc/common_types_cc.h"
#include "mip_cc/error_cc.h"
#include "mip_cc/string_list_cc.h"
#include "mip_cc/upe/action_cc.h"
#include "mip_cc/upe/metadata_dictionary_cc.h"

Include dependency graph for metadata_action_cc.h:

Go to the source code of this file.

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_MetadataAction_GetMetadataToRemove(const mip_cc_action action
	Gets a "metadata" action's metadata to remove.

Variables
mip_cc_string_list mip_cc_error *	errorInfo
mip_cc_metadata_dictionary *	metadata
mip_cc_string_list *	metadataNames

Detailed Description

Contains C API definitions for "metadata" label policy action.

Definition in file metadata_action_cc.h.

Function Documentation

MIP_CC_API()

MIP_CC_API

(

mip_cc_result

)

const

Gets a "metadata" action's metadata to remove.

Gets a "metadata" action's metadata to add.

Parameters

action	"metadata" action
metadataNames	[Output] Key names of metadata to remove, memory owned by caller
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

The 'metadataNames' variable must be released by the caller by calling MIP_CC_ReleaseStringList

Removing metadata should be done before adding metadata

Parameters

action	"metadata" action
metadata	[Output] list of metadata entries to add, memory owned by caller
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

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

Removing metadata should be done before adding metadata

Variable Documentation

errorInfo

mip_cc_metadata_dictionary mip_cc_error* errorInfo

Definition at line 57 of file metadata_action_cc.h.

metadata

mip_cc_metadata_dictionary* metadata

Definition at line 73 of file metadata_action_cc.h.

metadataNames

mip_cc_string_list* metadataNames

Definition at line 56 of file metadata_action_cc.h.