The generalInvoiceResponse ATL COM module loads &
analyzes electronic responses to general invoice requests
analyzes electronic responses to general invoice requests
API browser of generalInvoiceResponse450 COM module
 IAddress::GetAbortInfo method |
 |
||
|---|---|---|---|
|
Gets the abort information string with the error coded in the module language.
Call this method whenever the returned pbStatus variable of the primarily called method is VARIANT_FALSE and this primarily called method is not an iterator (GetFirst/GetNext methods). In the later case VARIANT_FALSE signals the end of data. |
|||
| |||
| Restful webservice calling syntax |
|||
| [POST] | /baseURL/IAddress/GetAbortInfo | ||
| [JSON input data] | pIAddress: | longValue, //interface address |
|
| [JSON result data] | pbstrAbort: pbStatus: |
"utf8StringValue", booleanValue |
|
| [HTTP result status] | 200 | Return status 200 signals a successful method call | |
| 204 | Return status 204 (noContent) signals that the end of an iteration is reached | ||
| >= 400 | Return status >= 400 signals an unsuccessful function call. The returned JSON{errorCode: code, errorText:"text"} supplies the error message the same as GetAbortInfo() would do. | ||
| |||
| C/C++ calling syntax |
|||
| HRESULT GetAbortInfo( | BSTR
VARIANT_BOOL |
*pbstrAbort,
*pbStatus); |
|
| [C/C++ return value] | S_OK | This value is returned if the function call was successful. | |
| S_FALSE | This value is returned if the end of an iteration is reached | ||
| E_name | This value is returned if the function call was unsuccessful and an error exception was generated. Note that if you are using SmartPointers an exception is thrown under these conditions. | ||
| |||
| Calling argument description |
|||
| [out] BSTR | *pbstrAbort | Abort information string coded in the module language. | |
| [out,retval] VARIANT_BOOL | *pbStatus | Return status of the method. If pbStatus is VARIANT_FALSE then an error-in-error situation occurred. | |
|
|||