pushAdminMessage COM module is a data
exchange system for treatment messages
exchange system for treatment messages
API browser of pushAdminMessage450 COM module
IPushAdminMessageManager::LoadXML method | |||
---|---|---|---|
Loads a previously generated XML infoset back into memory for further processing via the returned interface handles. The PushAdminMessage450 COM module understands and processes the pushAdminMessage_450 XSD standard.
To analyze and retrieve the loaded data use the returned instance of the IPushAdminMessageRequest interface and/or preview/print the data. |
|||
Restful webservice calling syntax | |||
[POST] | /baseURL/IPushAdminMessageManager/LoadXML?param | ||
[param] | pIPushAdminMessageManager=longValue& bstrInputFile=urlEncodedString + <application/octet-stream> input_file_upload_stream |
||
[JSON result data] | pbstrUsedSchema: pIPushAdminMessageRequest: 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. | ||
C/C++ calling syntax | |||
HRESULT LoadXML( | BSTR
BSTR IPushAdminMessageRequest VARIANT_BOOL |
bstrInputFile,
*pbstrUsedSchema, **pIPushAdminMessageRequest, *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 | |||
[in] BSTR | bstrInputFile | The input XML infoset (full file name) that must be loaded and analyzed. | |
[out] BSTR | *pbstrUsedSchema | The full XSD schema name referenced by the of the loaded XML file.
Since there is only one understandable standard, the returned schema is pushAdminMessage_450.xsd. This variable is not set if the loading of an XML infoset was unsuccessful or the referenced XSD is not valid. |
|
[out] IPushAdminMessageRequest | **pIPushAdminMessageRequest | The IPushAdminMessageRequest interface handle that allows to add further 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. | |