API browser of generalFormResponse430 COM module


/images/arrow_right.png IGeneralFormResponse::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.

space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT GetAbortInfo( BSTR
VARIANT_BOOL
*pbstrAbort,
*pbStatus);
 
/images/arrow_right.png 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 occurred and GetAbortInfo should be called to retrieve the error string.
 
/images/arrow_right.png C/C++ return value
S_OK This value is returned if the function call was successful or if the return value of a boolean method signalling a true value. In this case the VARIANT_BOOL is set to VARIANT_TRUE.
S_FALSE This is the return value of a boolean method signalling a false return value. In this case the VARIANT_BOOL is set to VARIANT_FALSE.
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.