Diffusion C API  6.4.3
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
diffusion-api-error.h File Reference

Copyright © 2018 Push Technology Ltd., All Rights Reserved. More...

Typedefs

typedef struct
DIFFUSION_API_ERROR_T * 
DIFFUSION_API_ERROR
 Opaque diffusion API error data type.
 

Functions

int get_diffusion_api_error_code (DIFFUSION_API_ERROR error)
 Return the error's code. More...
 
const char * get_diffusion_api_error_description (DIFFUSION_API_ERROR error)
 Returns the API error description. More...
 
void diffusion_api_error_free (DIFFUSION_API_ERROR error)
 Free a diffusion API error. More...
 

Detailed Description

Copyright © 2018 Push Technology Ltd., All Rights Reserved.

Use is subject to license terms.

NOTICE: All information contained herein is, and remains the property of Push Technology. The intellectual and technical concepts contained herein are proprietary to Push Technology and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law.

Function Documentation

void diffusion_api_error_free ( DIFFUSION_API_ERROR  error)

Free a diffusion API error.

Parameters
errorerror to be freed.
int get_diffusion_api_error_code ( DIFFUSION_API_ERROR  error)

Return the error's code.

Parameters
errorthe API error
Returns
the error code. If 0 is returned, the provided error value does not contain an error.
const char* get_diffusion_api_error_description ( DIFFUSION_API_ERROR  error)

Returns the API error description.

Parameters
errorthe API error
Returns
the description. Will return NULL if the provided error value does not contain an error.