Query ato_ErrSoap objects.
More...
|
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.
|
|
Query ato_ErrSoap objects.
◆ 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.
◆ 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
-
err | the 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
-
err | the 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
-
err | the 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
-
err | the 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
-
err | the soap error object. |
- Returns
- the number or codes/subcodes.
◆ ato_errsoap_code_iterator()
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
-
err | the soap error object. |
iter | the address of the iterator to create - *iter must be NULL. This will be NULL if there is no collection. |
◆ ato_errsoap_code_firstv()
Get the first code of the collection.
This also initialises the iterator associated with the current sbdm timestamps.
- Parameters
-
err | the soap error object. |
- Returns
- a sub/code or NULL if none.
◆ ato_errsoap_code_nextv()
Get the next code of the collection.
- Parameters
-
err | the soap error object. |
- Returns
- a sub/code or NULL if none.
◆ ato_errsoap_code_value()
Returns the value of the code/subcode.
- Parameters
-
- Returns
- the value of the code/subcode or NULL if none.
◆ ato_errsoap_code_ns()
Returns the namespace of the code/subcode.
- Parameters
-
- Returns
- the namespace of the code/subcode or NULL if none.