API browser of miscValidator200 COM module


/images/arrow_right.png IValidate::GetAbortInfo method space
Fetches the abort/error information if there is any stored.
If any method generates an error/error string than the error situation is signaled by the VARIANT_BOOL status of that method. GetAbortInfo can then be used to retrieve the error code und error string.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IValidate/GetAbortInfo
[JSON input data] pIValidate: longValue,    //interface address
[JSON result data] pbstrAbortText:
plAbortCode:
pbStatus:
"utf8StringValue",
longValue,
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.
space
/images/arrow_right.png C/C++ calling syntax
HRESULT GetAbortInfo( BSTR
long
VARIANT_BOOL
*pbstrAbortText,
*plAbortCode,
*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.
space
/images/arrow_right.png Calling argument description
[out] BSTR *pbstrAbortText The abort information string that corresponds with the abort/error code. The abort string is empty if there is no error condition. Possibly S_FALSE was set by an iterator to signal end_of_data, which is seen as a "non-error".
[out] long *plAbortCode The abort code that corresponds with the abort/error string. The abort code is 0 if there is no error condition.
[out,retval] VARIANT_BOOL *pbStatus Return status of the method. If pbStatus is VARIANT_FALSE then an error occurred! No further information can be retrieved.
space