API browser of generalFormResponse450 COM module


/images/arrow_right.png IGeneralFormResponseManager::LoadXML method space
Loads a received XML infoset back into memory for further processing via the returned interface instance. The generalFormResponse450 COM module understands and processes the generalFormResponse_450 XSD standard as well as the predecessor, namely generalFormResponse_430.

To analyze and retrieve the received data use the returned instance of the IGeneralFormResponse interface and/or preview/print the data.

Since the infoset is possibly encrypted, call GetXMLInfo to decide if and which PFX certificate to supply for the decryption process.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralFormResponseManager/LoadXML?param
[param] pIGeneralFormResponseManager=longValue&
bstrInputFile=urlEncodedString&
bstrToPFXFile=urlEncodedString&
bstrToPFXPassword=urlEncodedString
+
<application/octet-stream> input_file_upload_stream
[JSON result data] pIGeneralFormResponse:
pbStatus:
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 LoadXML( BSTR
BSTR
BSTR
IGeneralFormResponse
VARIANT_BOOL
bstrInputFile,
bstrToPFXFile,
bstrToPFXPassword,
**pIGeneralFormResponse,
*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
[in] BSTR bstrInputFile The input XML infoset (full file name) that must be loaded and analyzed.
[in] BSTR bstrToPFXFile The file name of the PFX certificate that is the private certificate of the "toEAN" entity.
This variable is not used if the XML infoset is not encrypted.
[in] BSTR bstrToPFXPassword The password to open the PFX certificate.
This variable is not used if the XML infoset is not encrypted.
[out] IGeneralFormResponse **pIGeneralFormResponse The instance of a IGeneralFormResponse interface allows to read back all currently loaded data.

The handle is NULL if an error occurred.

[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.
space