Symisc Systems

Libcox C/C++ API Reference - Libcox Handle


Star Follow @symisc

Syntax

int libcox_init(libcox **ppHandle);


Obtaining a new libcox handle.

Description

This routine allocate and initialize a new libcox handle. The handle is usually returned in *ppHandle but, if the engine is unable to allocate memory to hold the libcox object, a NULL will be written into *ppHandle instead of a pointer to the libcox object. This routine is often the first API call that an application makes and is a prerequisite in order to play with the library.
After the freshly created handle is ready to execute on more commands via libcox_exec() or libcox_exec_fmt().


Parameters

ppHandle

OUT: A fresh libcox handle is written into this pointer.


Return value

LIBCOX_OK is returned on success. Any other return value indicates failure.


See also

libcox_exec, libcox_release, libcox_exec_result_destroy, libcox_config.