metadata_dictionary_cc.h File Reference

Contains C API definitions for a metadata dictionary. More...

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

Go to the source code of this file.

Classes
struct	mip_cc_metadata_entry
	Metadata entry. More...

Typedefs
typedef mip_cc_handle *	mip_cc_metadata_dictionary

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_CreateMetadataDictionary(const mip_cc_metadata_entry *entries
	Create a dictionary of string keys/values.
	MIP_CC_API (void) MIP_CC_ReleaseMetadataDictionary(mip_cc_metadata_dictionary dictionary)
	Release resources associated with a dictionary.

Variables
const int64_t	count
const int64_t mip_cc_metadata_dictionary *	dictionary
const int64_t mip_cc_metadata_dictionary mip_cc_error *	errorInfo
mip_cc_metadata_entry **	entries

Detailed Description

Contains C API definitions for a metadata dictionary.

Typedef Documentation

mip_cc_metadata_dictionary

typedef mip_cc_handle* mip_cc_metadata_dictionary

Function Documentation

MIP_CC_API() [1/2]

MIP_CC_API

(

mip_cc_result

)

const

Create a dictionary of string keys/values.

Get metadata entries that compose a dictionary.

Parameters

entries	Array of metadata entries
count	Number of metadata entries
dictionary	[Output] Newly-created dictionary
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

A mip_cc_dictionary must be freed by calling MIP_CC_ReleaseDictionary

Parameters

dictionary	Source dictionary
entries	[Output] Array of metadata entries, memory owned by mip_cc_dictionary object
count	[Output] Number of metadata entries
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

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

MIP_CC_API() [2/2]

MIP_CC_API

(

void

)

Release resources associated with a dictionary.

Parameters

dictionary

Dictionary to be released

Variable Documentation

count

mip_cc_metadata_entry int64_t* count

dictionary

const int64_t mip_cc_metadata_dictionary* dictionary

entries

mip_cc_metadata_entry** entries

errorInfo

mip_cc_metadata_entry int64_t mip_cc_error* errorInfo