The generalFormRequest ATL COM module manages
and fills out a PDF based form system
and fills out a PDF based form system
API browser of generalFormRequest430 COM module
IGeneralFormRequestManager::LoadXML method | |||
---|---|---|---|
Loads a previously generated XML infoset of type generalFormRequest_430.xsd or generalNotification_430.xsd back into memory for further processing and refinement via the returned interface handles. | |||
C/C++ calling syntax | |||
HRESULT LoadXML( | BSTR
BSTR long LanguageType BSTR IGeneralFormRequest IGeneralFormResult VARIANT_BOOL |
bstrInputFile,
*pbstrFormOID, *plFormVersion, *peFormLanguage, *pbstrUsedSchema, **ppIGeneralFormRequest, **ppIGeneralFormResult, *pbStatus); |
|
Calling argument description | |||
[in] BSTR | bstrInputFile | The full file name (path + name) of a XML infoset of type generalFormRequest_430.xsd, or generalNotificationt_430.xsd.
In the latter case the pdf_form_oid attribute must be defined and must stem form the medForms OID space otherwise an error is generated. |
|
[out] BSTR | *pbstrFormOID | The OID of the loaded PDF form.
This is of importance as soon as a partially populated PDF form is loaded as the PDF file name normally does not indicate such information. |
|
[out] long | *plFormVersion | The language of the loaded PDF form.
This is of importance as soon as a partially populated PDF form is loaded as the PDF file name normally does not indicate such information. |
|
[out] LanguageType | *peFormLanguage | The version of the loaded PDF form as 32-bit value where lFormVersion = 100*Major version + Minor version.
This is of importance as soon as a partially populated PDF form is loaded as the PDF file name normally does not indicate such information. |
|
[out] BSTR | *pbstrUsedSchema | The full XSD name of the loaded XML file. | |
[out] IGeneralFormRequest | **ppIGeneralFormRequest | The IGeneralFormRequest interface handle that allows to add further data.
The handle is NULL if an error occurred. |
|
[out] IGeneralFormResult | **ppIGeneralFormResult | The IGeneralFormResponse 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. | ||