string_list_cc.h File Reference

Contains C API definitions for common string list. 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"

Include dependency graph for string_list_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_string_list

Functions
	MIP_CC_API (mip_cc_result) MIP_CC_CreateStringList(const char **strings
	Create a string list.
	MIP_CC_API (void) MIP_CC_ReleaseStringList(mip_cc_string_list stringList)
	Release resources associated with a string list.

Variables
const int64_t	count
const int64_t mip_cc_string_list mip_cc_error *	errorInfo
const int64_t mip_cc_string_list *	stringList
const char ***	strings

Detailed Description

Contains C API definitions for common string list.

Definition in file string_list_cc.h.

Typedef Documentation

mip_cc_string_list

typedef mip_cc_handle* mip_cc_string_list

Definition at line 44 of file string_list_cc.h.

Function Documentation

MIP_CC_API() [1/2]

MIP_CC_API

(

mip_cc_result

)

const

Create a string list.

Get strings that compose a string list.

Parameters

strings	Array of strings
count	Number of strings
stringList	[Output] Newly-created string list
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

A mip_cc_string_list must be freed by calling MIP_CC_ReleaseStringList

Parameters

stringList	Source string list
strings	[Output] Array of strings, memory owned by mip_cc_string_list object
count	[Output] Number of strings
errorInfo	[Output] (Optional) Failure info if operation result is error

Returns

Result code indicating success or failure

Note

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

MIP_CC_API() [2/2]

MIP_CC_API

(

void

)

Release resources associated with a string list.

Parameters

stringList

String list to be released

Variable Documentation

count

const char int64_t* count

Definition at line 60 of file string_list_cc.h.

errorInfo

const char int64_t mip_cc_error* errorInfo

Definition at line 62 of file string_list_cc.h.

stringList

const int64_t mip_cc_string_list* stringList

Definition at line 61 of file string_list_cc.h.

strings

const char*** strings

Definition at line 78 of file string_list_cc.h.