OpenCC C API

API in C language. More...

Macros
#define	OPENCC_DEFAULT_CONFIG_SIMP_TO_TRAD   "s2t.json"
	Filename of default Simplified to Traditional configuration.
#define	OPENCC_DEFAULT_CONFIG_TRAD_TO_SIMP   "t2s.json"
	Filename of default Traditional to Simplified configuration.

Typedefs
typedef void *	opencc_t
	Type of opencc descriptor.

Functions
OPENCC_EXPORT opencc_t	opencc_open (const char *configFileName)
	Makes an instance of opencc. More...
OPENCC_EXPORT int	opencc_close (opencc_t opencc)
	Destroys an instance of opencc. More...
OPENCC_EXPORT size_t	opencc_convert_utf8_to_buffer (opencc_t opencc, const char *input, size_t length, char *output)
	Converts UTF-8 string. More...
OPENCC_EXPORT char *	opencc_convert_utf8 (opencc_t opencc, const char *input, size_t length)
	Converts UTF-8 string This function returns an allocated C-Style string, which stores the converted string. More...
OPENCC_EXPORT void	opencc_convert_utf8_free (char *str)
	Releases allocated buffer by opencc_convert_utf8. More...
OPENCC_EXPORT const char *	opencc_error (void)
	Returns the last error message. More...

Detailed Description

API in C language.

Function Documentation

opencc_close()

OPENCC_EXPORT int opencc_close

(

opencc_t

opencc

)

Destroys an instance of opencc.

Parameters

opencc

The description pointer.

Returns

0 on success or non-zero number on failure.

opencc_convert_utf8()

OPENCC_EXPORT char* opencc_convert_utf8	(	opencc_t	opencc,
		const char *	input,
		size_t	length
	)

Converts UTF-8 string This function returns an allocated C-Style string, which stores the converted string.

You MUST call opencc_convert_utf8_free() to release allocated memory.

Parameters

opencc	The opencc description pointer.
input	The UTF-8 encoded string.
length	The maximum length in byte to convert. If length is (size_t)-1, the whole string (terminated by '\0') will be converted.

Returns

The newly allocated UTF-8 string that stores text converted, or NULL on error.

opencc_convert_utf8_free()

OPENCC_EXPORT void opencc_convert_utf8_free

(

char *

str

)

Releases allocated buffer by opencc_convert_utf8.

Parameters

str	Pointer to the allocated string buffer by opencc_convert_utf8.

opencc_convert_utf8_to_buffer()

OPENCC_EXPORT size_t opencc_convert_utf8_to_buffer	(	opencc_t	opencc,
		const char *	input,
		size_t	length,
		char *	output
	)

Converts UTF-8 string.

Parameters

opencc	The opencc description pointer.
input	The UTF-8 encoded string.
length	The maximum length in byte to convert. If length is (size_t)-1, the whole string (terminated by '\0') will be converted.
output	The buffer to store converted text. You MUST make sure this buffer has sufficient space.

Returns

The length of converted string or (size_t)-1 on error.

opencc_error()

OPENCC_EXPORT const char* opencc_error

(

void

)

Returns the last error message.

Note that this function is the only one which is NOT thread-safe.

opencc_open()

OPENCC_EXPORT opencc_t opencc_open

(

const char *

configFileName

)

Makes an instance of opencc.

Parameters

configFileName

Location of configuration file. If this is set to NULL, OPENCC_DEFAULT_CONFIG_SIMP_TO_TRAD will be loaded.

Returns

A description pointer of the newly allocated instance of opencc. On error the return value will be (opencc_t) -1.