sbrcsr  3.2.0
ATOMAS sbrcsr

A sbr_Sbdm object can contain one or more sbr_MsgEventItem objects. More...

Typedefs

typedef struct _sbr_MsgEventItem sbr_MsgEventItem
 This contains information from the service about the request and transaction that occurred. More...
 
typedef struct _sbr_MsgEventItemLocation sbr_MsgEventItemLocation
 A sbr_MsgEventItem can contain 1 or more of these.
 
typedef struct _sbr_MsgEventItemParam sbr_MsgEventItemParam
 A sbr_MsgEventItem can contain 0 or more of these.
 

Functions

SBR_CSR_EXPORT const char * sbr_msgevent_code (sbr_MsgEventItem *eventitem)
 Return the error code. More...
 
SBR_CSR_EXPORT const char * sbr_msgevent_severity (sbr_MsgEventItem *eventitem)
 Return the severity. More...
 
SBR_CSR_EXPORT const char * sbr_msgevent_shortdesc (sbr_MsgEventItem *eventitem)
 Return the short description. More...
 
SBR_CSR_EXPORT const char * sbr_msgevent_longdesc (sbr_MsgEventItem *eventitem)
 Return the long description. More...
 
SBR_CSR_EXPORT size_t sbr_msgevent_location_count (sbr_MsgEventItem *eventitem)
 Return the number of locations this event applies to. More...
 
SBR_CSR_EXPORT void sbr_msgevent_location_iterator (sbr_MsgEventItem *eventitem, ato_Iterator **iter)
 Create an iterator the collection of locations - caller must free. More...
 
SBR_CSR_EXPORT sbr_MsgEventItemLocationsbr_msgevent_location_firstv (sbr_MsgEventItem *eventitem)
 Return the first location. More...
 
SBR_CSR_EXPORT sbr_MsgEventItemLocationsbr_msgevent_location_nextv (sbr_MsgEventItem *eventitem)
 Return the next location. More...
 
SBR_CSR_EXPORT size_t sbr_msgevent_location_sequencenr (sbr_MsgEventItemLocation *location)
 Return the sequence number of a particular document in the incoming sbr_Sbdm. More...
 
SBR_CSR_EXPORT const char * sbr_msgevent_location_path (sbr_MsgEventItemLocation *location)
 The location path field indicates, via an XPath expression, the element in the incoming XBRL document to which the event item refers. More...
 
SBR_CSR_EXPORT size_t sbr_msgevent_param_count (sbr_MsgEventItem *eventitem)
 Return the number of parameters this event has. More...
 
SBR_CSR_EXPORT void sbr_msgevent_param_iterator (sbr_MsgEventItem *eventitem, ato_Iterator **iter)
 Create an iterator the collection of paramters - caller must free. More...
 
SBR_CSR_EXPORT sbr_MsgEventItemParamsbr_msgevent_param_firstv (sbr_MsgEventItem *eventitem)
 Return the first parameter. More...
 
SBR_CSR_EXPORT sbr_MsgEventItemParamsbr_msgevent_param_nextv (sbr_MsgEventItem *eventitem)
 Return the next parameter. More...
 
SBR_CSR_EXPORT const char * sbr_msgevent_param_name (sbr_MsgEventItemParam *param)
 The parameter name. More...
 
SBR_CSR_EXPORT const char * sbr_msgevent_param_value (sbr_MsgEventItemParam *param)
 The parameter value. More...
 

Detailed Description

A sbr_Sbdm object can contain one or more sbr_MsgEventItem objects.

Typedef Documentation

◆ sbr_MsgEventItem

typedef struct _sbr_MsgEventItem sbr_MsgEventItem

This contains information from the service about the request and transaction that occurred.

It represents both success and any business level error conditions, with a successful transaction containing at least one 'Information' severity level event item. The maximum severity level of all the event items is returned using sbr_sbdm_maxseveritycode().

Function Documentation

◆ sbr_msgevent_code()

SBR_CSR_EXPORT const char* sbr_msgevent_code ( sbr_MsgEventItem eventitem)

Return the error code.

Parameters
eventitemthe eventitem
Returns
the error code

◆ sbr_msgevent_severity()

SBR_CSR_EXPORT const char* sbr_msgevent_severity ( sbr_MsgEventItem eventitem)

Return the severity.

Parameters
eventitemthe eventitem
Returns
the severity

◆ sbr_msgevent_shortdesc()

SBR_CSR_EXPORT const char* sbr_msgevent_shortdesc ( sbr_MsgEventItem eventitem)

Return the short description.

Parameters
eventitemthe eventitem
Returns
the short description

◆ sbr_msgevent_longdesc()

SBR_CSR_EXPORT const char* sbr_msgevent_longdesc ( sbr_MsgEventItem eventitem)

Return the long description.

Parameters
eventitemthe eventitem
Returns
the long description

◆ sbr_msgevent_location_count()

SBR_CSR_EXPORT size_t sbr_msgevent_location_count ( sbr_MsgEventItem eventitem)

Return the number of locations this event applies to.

Locations refer an incoming sbr_Doc in the sbr_Request.

Parameters
eventitemthe eventitem
Returns
the number of locations

◆ sbr_msgevent_location_iterator()

SBR_CSR_EXPORT void sbr_msgevent_location_iterator ( sbr_MsgEventItem eventitem,
ato_Iterator **  iter 
)

Create an iterator the collection of locations - caller must free.

This is useful if a collection is being shared between threads and each thread has its own iterator.

If this is not the case then the sbr_msgevent_location_firstv() and sbr_msgevent_location_nextv() methods are simpler and this method can be ignored.

Parameters
eventitemthe eventitem.
iterthe address of the iterator to create - *iter must be NULL. This will be NULL if there is no collection.

◆ sbr_msgevent_location_firstv()

SBR_CSR_EXPORT sbr_MsgEventItemLocation* sbr_msgevent_location_firstv ( sbr_MsgEventItem eventitem)

Return the first location.

Parameters
eventitemthe eventitem.
Returns
the location or NULL if none.

◆ sbr_msgevent_location_nextv()

SBR_CSR_EXPORT sbr_MsgEventItemLocation* sbr_msgevent_location_nextv ( sbr_MsgEventItem eventitem)

Return the next location.

Parameters
eventitemthe eventitem.
Returns
the location or NULL if none.

◆ sbr_msgevent_location_sequencenr()

SBR_CSR_EXPORT size_t sbr_msgevent_location_sequencenr ( sbr_MsgEventItemLocation location)

Return the sequence number of a particular document in the incoming sbr_Sbdm.

Parameters
locationthe eventitem location
Returns
the sequence number or 0 if none or the index is out of range.

◆ sbr_msgevent_location_path()

SBR_CSR_EXPORT const char* sbr_msgevent_location_path ( sbr_MsgEventItemLocation location)

The location path field indicates, via an XPath expression, the element in the incoming XBRL document to which the event item refers.

Parameters
locationthe eventitem location
Returns
the location path or NULL if none or the index is out of range.

◆ sbr_msgevent_param_count()

SBR_CSR_EXPORT size_t sbr_msgevent_param_count ( sbr_MsgEventItem eventitem)

Return the number of parameters this event has.

Parameters
eventitemthe eventitem.
Returns
the number of parameters.

◆ sbr_msgevent_param_iterator()

SBR_CSR_EXPORT void sbr_msgevent_param_iterator ( sbr_MsgEventItem eventitem,
ato_Iterator **  iter 
)

Create an iterator the collection of paramters - caller must free.

This is useful if a collection is being shared between threads and each thread has its own iterator.

If this is not the case then the sbr_msgevent_param_firstv() and sbr_msgevent_param_nextv() methods are simpler and this method can be ignored.

Parameters
eventitemthe eventitem.
iterthe address of the iterator to create - *iter must be NULL. This will be NULL if there is no collection.

◆ sbr_msgevent_param_firstv()

SBR_CSR_EXPORT sbr_MsgEventItemParam* sbr_msgevent_param_firstv ( sbr_MsgEventItem eventitem)

Return the first parameter.

Parameters
eventitemthe eventitem.
Returns
the parameter or NULL if none.

◆ sbr_msgevent_param_nextv()

SBR_CSR_EXPORT sbr_MsgEventItemParam* sbr_msgevent_param_nextv ( sbr_MsgEventItem eventitem)

Return the next parameter.

Parameters
eventitemthe eventitem.
Returns
the parameter or NULL if none.

◆ sbr_msgevent_param_name()

SBR_CSR_EXPORT const char* sbr_msgevent_param_name ( sbr_MsgEventItemParam param)

The parameter name.

Parameters
paramthe eventitem parameter.
Returns
the parameter name or NULL if none.

◆ sbr_msgevent_param_value()

SBR_CSR_EXPORT const char* sbr_msgevent_param_value ( sbr_MsgEventItemParam param)

The parameter value.

Parameters
paramthe eventitem parameter.
Returns
the parameter value or NULL if none.