Memory Management
Reference the Vivox Core SDK API.
Read time 2 minutesLast updated 8 months ago
Functions
Name | |
|---|---|
| VIVOXSDK_DLLEXPORT int | vx_cookie_create(const char * value, VX_COOKIE * cookie) Allocate and initialize a cookie. |
| VIVOXSDK_DLLEXPORT int | vx_cookie_free(VX_COOKIE * cookie) Free a cookie. |
| VIVOXSDK_DLLEXPORT char * | vx_strdup(const char * ) Allocate string data to send to the SDK. |
| VIVOXSDK_DLLEXPORT int | vx_free(char * ) Free string data returned to the application. |
| VIVOXSDK_DLLEXPORT int | vx_on_application_exit(void ) Some applications may need to call this routine before exiting. |
| VIVOXSDK_DLLEXPORT int | vx_destroy_message(vx_message_base_t * message) Deallocate any message of any type. |
| VIVOXSDK_DLLEXPORT int | destroy_req(vx_req_base_t * pCmd) Destroy a request of any type. |
| VIVOXSDK_DLLEXPORT int | destroy_resp(vx_resp_base_t * pCmd) Deallocate a response object of any type. |
| VIVOXSDK_DLLEXPORT int | destroy_evt(vx_evt_base_t * pCmd) Free any event of any type. |
Functions Documentation
function vx_cookie_create
VIVOXSDK_DLLEXPORT int vx_cookie_create( const char * value, VX_COOKIE * cookie)
Allocate and initialize a cookie.
function vx_cookie_free
VIVOXSDK_DLLEXPORT int vx_cookie_free( VX_COOKIE * cookie)
Free a cookie.
function vx_strdup
VIVOXSDK_DLLEXPORT char * vx_strdup( const char * )
Allocate string data to send to the SDK.
Note: This function will not work until vx_initialize3() is called and after vx_uninitialize() is called.
function vx_free
VIVOXSDK_DLLEXPORT int vx_free( char * )
Free string data returned to the application.
Note: This function will not work until vx_initialize3() is called and after vx_uninitialize() is called.
This function is rarely used in practice.
function vx_on_application_exit
VIVOXSDK_DLLEXPORT int vx_on_application_exit( void )
Some applications may need to call this routine before exiting.
Note: Applications must call vx_uninitialize() before calling this routine.
Attention: PC, console, and mobile applications are not required to call this routine because it has no effect for applications on these platforms.
function vx_destroy_message
VIVOXSDK_DLLEXPORT int vx_destroy_message( vx_message_base_t * message)
Deallocate any message of any type.
function destroy_req
VIVOXSDK_DLLEXPORT int destroy_req( vx_req_base_t * pCmd)
Destroy a request of any type.
function destroy_resp
VIVOXSDK_DLLEXPORT int destroy_resp( vx_resp_base_t * pCmd)
Deallocate a response object of any type.
function destroy_evt
VIVOXSDK_DLLEXPORT int destroy_evt( vx_evt_base_t * pCmd)
Free any event of any type.