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_MsgEventItemLocation * | sbr_msgevent_location_firstv (sbr_MsgEventItem *eventitem) |
Return the first location. More... | |
SBR_CSR_EXPORT sbr_MsgEventItemLocation * | sbr_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_MsgEventItemParam * | sbr_msgevent_param_firstv (sbr_MsgEventItem *eventitem) |
Return the first parameter. More... | |
SBR_CSR_EXPORT sbr_MsgEventItemParam * | sbr_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... | |
A sbr_Sbdm object can contain one or more sbr_MsgEventItem objects.
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().
SBR_CSR_EXPORT const char * sbr_msgevent_code | ( | sbr_MsgEventItem * | eventitem | ) |
Return the error code.
eventitem | the eventitem |
SBR_CSR_EXPORT const char * sbr_msgevent_severity | ( | sbr_MsgEventItem * | eventitem | ) |
Return the severity.
eventitem | the eventitem |
SBR_CSR_EXPORT const char * sbr_msgevent_shortdesc | ( | sbr_MsgEventItem * | eventitem | ) |
Return the short description.
eventitem | the eventitem |
SBR_CSR_EXPORT const char * sbr_msgevent_longdesc | ( | sbr_MsgEventItem * | eventitem | ) |
Return the long description.
eventitem | the eventitem |
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.
eventitem | the eventitem |
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.
eventitem | the eventitem. |
iter | the address of the iterator to create - *iter must be NULL. This will be NULL if there is no collection. |
SBR_CSR_EXPORT sbr_MsgEventItemLocation * sbr_msgevent_location_firstv | ( | sbr_MsgEventItem * | eventitem | ) |
Return the first location.
eventitem | the eventitem. |
SBR_CSR_EXPORT sbr_MsgEventItemLocation * sbr_msgevent_location_nextv | ( | sbr_MsgEventItem * | eventitem | ) |
Return the next location.
eventitem | the eventitem. |
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.
location | the eventitem location |
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.
location | the eventitem location |
SBR_CSR_EXPORT size_t sbr_msgevent_param_count | ( | sbr_MsgEventItem * | eventitem | ) |
Return the number of parameters this event has.
eventitem | the eventitem. |
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.
eventitem | the eventitem. |
iter | the address of the iterator to create - *iter must be NULL. This will be NULL if there is no collection. |
SBR_CSR_EXPORT sbr_MsgEventItemParam * sbr_msgevent_param_firstv | ( | sbr_MsgEventItem * | eventitem | ) |
Return the first parameter.
eventitem | the eventitem. |
SBR_CSR_EXPORT sbr_MsgEventItemParam * sbr_msgevent_param_nextv | ( | sbr_MsgEventItem * | eventitem | ) |
Return the next parameter.
eventitem | the eventitem. |
SBR_CSR_EXPORT const char * sbr_msgevent_param_name | ( | sbr_MsgEventItemParam * | param | ) |
The parameter name.
param | the eventitem parameter. |
SBR_CSR_EXPORT const char * sbr_msgevent_param_value | ( | sbr_MsgEventItemParam * | param | ) |
The parameter value.
param | the eventitem parameter. |