API browser of generalnotification451 COM module


/images/arrow_right.png IGeneralNotificationManager::LoadXML method space
Loads a received XML infoset back into memory for further processing via the returned interface instances. The generalNotification450 COM module understands and processes the generalNotification450 XSD standard as well as both predecessors, namely generalNotification440 and generalNotification430.

To analyze and retrieve the received data use the returned instance of the IGeneralNotificationResponse interface and/or preview/print the data. To generate a reply call the IGeneralNotificationRequest::SetReply method followed by the GetXML method. The latter one generates the new XML infoset ready to send back.

space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralNotificationManager/LoadXML?param
[param] pIGeneralNotificationManager=longValue&
bstrInputFile=urlEncodedString&
bstrToPFXFile=urlEncodedString&
bstrToPFXPassword=urlEncodedString
+
<application/octet-stream> input_file_upload_stream
[JSON result data] pIGeneralNotificationRequest:
pIGeneralNotificationResponse:
pbStatus:
longValue,
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
IGeneralNotificationRequest
IGeneralNotificationResponse
VARIANT_BOOL
bstrInputFile,
bstrToPFXFile,
bstrToPFXPassword,
**pIGeneralNotificationRequest,
**pIGeneralNotificationResponse,
*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 full file name (path + name) of a XML infoset.
[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] IGeneralNotificationRequest **pIGeneralNotificationRequest The instance of a IGeneralNotificationRequest interface allows to define/override data. This instance given here is in the first place needed the make a reply.

The handle is NULL if an error occurred.

[out] IGeneralNotificationResponse **pIGeneralNotificationResponse The instance of a IGeneralNotificationResponse 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