The generalCreditRequest ATL COM module for
generating electronic and paper based credit requests
generating electronic and paper based credit requests
API browser of generalCreditRequest450 COM module
IGeneralCreditResult::GetAbortInfo method | |||
---|---|---|---|
Get 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 the primarily called method is not an iterator (GetFirst/GetNext). In the later case VARIANT_FALSE signals the end of data. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IGeneralCreditResult/GetAbortInfo | ||
[JSON input data] | pIGeneralCreditResult: | 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. If the abort string is empty then there is no error condition - S_FALSE was set (e.g. in an iterator to signal end_of_data) | |
[out,retval] VARIANT_BOOL | *pbStatus | Return status. VARIANT_TRUE means S_OK, VARIANT_FALSE means S_FALSE (e.g. in an iterator) or an error (E_name). In the later case check for possible errors with the GetAbortInfo method. |
|