The generalFormRequest ATL COM module manages
and fills out a PDF based form system
API browser of generalFormRequest450 COM module


/images/arrow_right.png IGeneralFormRequestManager::LoadXML method space
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.
space
/images/arrow_right.png Restful webservice calling syntax
[POST] /baseURL/IGeneralFormRequestManager/LoadXML?param
[param] pIGeneralFormRequestManager=longValue&
bstrInputFile=urlEncodedString
+
<application/octet-stream> input_file_upload_stream
[JSON result data] pbstrFormOID:
plFormVersion:
peFormLanguage:
pbstrIntermediates:
peHasDirectSend:
pbstrUsedSchema:
pIGeneralFormRequest:
pIGeneralFormResult:
pbStatus:		 "utf8StringValue",
longValue,
longValue,
"utf8StringValue",
longValue,
"utf8StringValue",
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
long
LanguageType
BSTR
YesNoType
BSTR
IGeneralFormRequest
IGeneralFormResult
VARIANT_BOOL 		bstrInputFile,
*pbstrFormOID,
*plFormVersion,
*peFormLanguage,
*pbstrIntermediates,
*peHasDirectSend,
*pbstrUsedSchema,
**pIGeneralFormRequest,
**pIGeneralFormResult,
*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 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 *pbstrIntermediates A whitespace separated list of intermediates, that can be used to reach the intended recipient. The individual intermediates are formatted as:
    name{gln}

Please note, that this static routing information is on a per form basis and purely serves as a help/hint for the routing. Furthermore, this data can be set only for "named" forms, that is forms with a predefined and fixed recipient.
[out] YesNoType *peHasDirectSend A Boolean designating if the form in question includes a "direct send" feature (enYes) or not (enNo).
[out] BSTR *pbstrUsedSchema The full XSD name of the loaded XML file.
[out] IGeneralFormRequest **pIGeneralFormRequest The IGeneralFormRequest interface handle that allows to add further data.
The handle is NULL if an error occurred.
[out] IGeneralFormResult **pIGeneralFormResult 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.
space