atobase  3.2.0
ATOMAS atobase
SOAP Error

Query ato_ErrSoap objects. More...

Typedefs

typedef struct _ato_ErrSoap ato_ErrSoap
 This object represents a SOAP fault. More...
 
typedef struct _ato_ErrSoapCode ato_ErrSoapCode
 This object represents a code or subcode node in a SOAP fault.
 

Functions

ATO_EXPORT bool ato_errsoap_issoaperr (ato_ErrSoap *err)
 Confirms whether or not the error object is of the expected type. More...
 
ATO_EXPORT const char * ato_errsoap_node (ato_ErrSoap *err)
 Decribes the service node where the error occured. More...
 
ATO_EXPORT const char * ato_errsoap_reason (ato_ErrSoap *err)
 Describes the specifics of the particular error condition, and reflects the finest granularity of subcode provided in the fault. More...
 
ATO_EXPORT const char * ato_errsoap_detail (ato_ErrSoap *err)
 This contains low-level details of the fault and is only provided in non-production environments. More...
 
ATO_EXPORT size_t ato_errsoap_code_count (ato_ErrSoap *err)
 Returns the number of subcodes including the toplevel code. More...
 
ATO_EXPORT void ato_errsoap_code_iterator (ato_ErrSoap *err, ato_Iterator **iter)
 Create an iterator for the collection of errors - caller must free. More...
 
ATO_EXPORT ato_ErrSoapCodeato_errsoap_code_firstv (ato_ErrSoap *err)
 Get the first code of the collection. More...
 
ATO_EXPORT ato_ErrSoapCodeato_errsoap_code_nextv (ato_ErrSoap *err)
 Get the next code of the collection. More...
 
ATO_EXPORT const char * ato_errsoap_code_value (ato_ErrSoapCode *code)
 Returns the value of the code/subcode. More...
 
ATO_EXPORT const char * ato_errsoap_code_ns (ato_ErrSoapCode *code)
 Returns the namespace of the code/subcode. More...
 

Detailed Description

Query ato_ErrSoap objects.

Typedef Documentation

◆ ato_ErrSoap

typedef struct _ato_ErrSoap ato_ErrSoap

This object represents a SOAP fault.

This object will be created and attached to the top level generic ato_Err object returned by the method in which the error occurred. Use ato_err_customobj() to retrieve this object.

Function Documentation

◆ ato_errsoap_issoaperr()

ATO_EXPORT bool ato_errsoap_issoaperr ( ato_ErrSoap err)

Confirms whether or not the error object is of the expected type.

The other methods will assert if this is false.

Parameters
errthe soap error object.
Returns
TRUE if err is of type ato_ErrSoap, otherwise false.

◆ ato_errsoap_node()

ATO_EXPORT const char* ato_errsoap_node ( ato_ErrSoap err)

Decribes the service node where the error occured.

Parameters
errthe soap error object.
Returns
service node

◆ ato_errsoap_reason()

ATO_EXPORT const char* ato_errsoap_reason ( ato_ErrSoap err)

Describes the specifics of the particular error condition, and reflects the finest granularity of subcode provided in the fault.

Parameters
errthe soap error object.
Returns
the reason details.

◆ ato_errsoap_detail()

ATO_EXPORT const char* ato_errsoap_detail ( ato_ErrSoap err)

This contains low-level details of the fault and is only provided in non-production environments.

Parameters
errthe soap error object.
Returns
fault details.

◆ ato_errsoap_code_count()

ATO_EXPORT size_t ato_errsoap_code_count ( ato_ErrSoap err)

Returns the number of subcodes including the toplevel code.

Parameters
errthe soap error object.
Returns
the number or codes/subcodes.

◆ ato_errsoap_code_iterator()

ATO_EXPORT void ato_errsoap_code_iterator ( ato_ErrSoap err,
ato_Iterator **  iter 
)

Create an iterator for the collection of errors - caller must free.

This is useful if a collection is being shared between threads and each thread has its own iterator. It is also useful in the unlikely case that higher level code and nested code are bother iterating the underlying collection.

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

Parameters
errthe soap error object.
iterthe address of the iterator to create - *iter must be NULL. This will be NULL if there is no collection.

◆ ato_errsoap_code_firstv()

ATO_EXPORT ato_ErrSoapCode* ato_errsoap_code_firstv ( ato_ErrSoap err)

Get the first code of the collection.

This also initialises the iterator associated with the current sbdm timestamps.

Parameters
errthe soap error object.
Returns
a sub/code or NULL if none.

◆ ato_errsoap_code_nextv()

ATO_EXPORT ato_ErrSoapCode* ato_errsoap_code_nextv ( ato_ErrSoap err)

Get the next code of the collection.

Parameters
errthe soap error object.
Returns
a sub/code or NULL if none.

◆ ato_errsoap_code_value()

ATO_EXPORT const char* ato_errsoap_code_value ( ato_ErrSoapCode code)

Returns the value of the code/subcode.

Parameters
codethe soap error code.
Returns
the value of the code/subcode or NULL if none.

◆ ato_errsoap_code_ns()

ATO_EXPORT const char* ato_errsoap_code_ns ( ato_ErrSoapCode code)

Returns the namespace of the code/subcode.

Parameters
codethe soap error code.
Returns
the namespace of the code/subcode or NULL if none.