The statusRequest ATL COM module is capable of
querying the status of a reference object
querying the status of a reference object
API browser of statusRequest430 COM module
 IStatusRequestManager::GetXML method |
|||
|---|---|---|---|
|
GetXML generates the XML infoset based on the data of the IRequest interface, validates the XML against the XSD schema, and stores the XML content as UTF8 file in the internal working directory. The full file name to this XML document is replied in the pbstrOutputFile output variable.
The XML file must be saved to a different location as all temporary XML files in the working directory are deleted before the COM module shuts down! |
 |
||
| C/C++ calling syntax |
|||
| HRESULT GetXML( | BSTR
long long IStatusResult VARIANT_BOOL |
*pbstrOutputFile,
*plValidationError, *plTimestamp, **ppIStatusResult, *pbStatus); |
|
| Calling argument description |
|||
| [out] BSTR | *pbstrOutputFile | The full file name (path + name) where the XML infoset of type statusRequest_430.xsd is stored in UTF-8 mode.
The XML file must be saved to a different location as all temporary XML files in the working directory are deleted before the COM module shuts down! |
|
| [out] long | *plValidationError | lValidationError is filled with the validation error code returned by the MSXML-4 parser. A zero value indicates that the validation was successful. | |
| [out] long | *plTimestamp | the timestamp of the XML document as epoch time (seconds elapsed since 1.1.1970).
Note, that this is the module generated 3rd parameter of the 3 parameters that form a request object. Therefore, this timestamp should eventually be stored for later usage. |
|
| [out] IStatusResult | **ppIStatusResult | The IStatusResult interface handle that allows to get all loaded data back.
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. | |
| 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. | ||