and fills out a PDF based form system
 IGeneralFormRequestManager::LoadPDF method |
 |
||
|---|---|---|---|
|
Loads either a previously saved PDF form or PDF form template into memory for further processing and refinement via the returned interface handles.
PDF form template is defined by the corresponding medForms OID, whereas the absolute OID or the shortened form (e.g. medforms.20.30.5050) can be supplied. |
|||
| |||
| Restful webservice calling syntax |
|||
| [POST] | /baseURL/IGeneralFormRequestManager/LoadPDF?param | ||
| [param] | pIGeneralFormRequestManager=longValue& bstrPDFTemplate=urlEncodedString + <application/octet-stream> input_file_upload_stream |
||
| [JSON result data] | pbstrFormOID: plFormVersion: peFormLanguage: pbstrIntermediates: peHasDirectSend: pIGeneralFormRequest: pIGeneralFormResult: pbStatus: |
"utf8StringValue", longValue, longValue, "utf8StringValue", longValue, 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. | ||
| |||
| C/C++ calling syntax |
|||
| HRESULT LoadPDF( | BSTR
BSTR long LanguageType BSTR YesNoType IGeneralFormRequest IGeneralFormResult VARIANT_BOOL |
bstrPDFTemplate,
*pbstrFormOID, *plFormVersion, *peFormLanguage, *pbstrIntermediates, *peHasDirectSend, **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. | ||
| |||
| Calling argument description |
|||
| [in] BSTR | bstrPDFTemplate | Either a full file name (path + name) of a previously saved PDF form or a medForms OID as surrogate for a PDF form template. The medForms OID can be supplied as absolute OID or in shortened form (e.g. medforms.20.30.5050).
In Restful webservice system: Since a medForms OID is not a physical file, there is no joint uploading process, e.g. if bstrPDFTemplate=medFormsOID than perform a normal POST <application/json> Restful call instead of the otherwise requested POST urlEncoded + <application/octet-stream> call! |
|
| [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 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] LanguageType | *peFormLanguage | 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] 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, this information stems from the form itself and does not include the data from transport element of the XML itself., defines possible static routing 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] 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. | |
|
|||