das2C
das core C utilities (v3)
Public Member Functions
das_error_msg Struct Reference

Structure returned from das_get_error(). More...

#include <das2/util.h>

Public Member Functions

DAS_API das_error_msgdas_get_error (void)
 Return the saved das2 error message buffer. More...
 
DAS_API void das_error_free (das_error_msg *pMsg)
 Free an error message structure allocated on the heap. More...
 

Detailed Description

Structure returned from das_get_error().

To get error messages libdas2 must be set to an error dispostition of DAS2_ERRDIS_RET

Member Function Documentation

◆ das_get_error()

DAS_API das_error_msg * das_get_error ( void  )

Return the saved das2 error message buffer.

Returns
an instance of Das2ErrorMessage. The struct returned contains the error code, formatted message, max message size, and the source file, function name, and line number of where the message originated.

◆ das_error_free()

DAS_API void das_error_free ( das_error_msg pMsg)

Free an error message structure allocated on the heap.

Parameters
pMsgthe message buffer to free

The documentation for this struct was generated from the following file: