API browser of generalFormRequest450 COM module


/images/arrow_right.png 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.

space
 
/images/arrow_right.png C/C++ calling syntax
HRESULT LoadPDF( BSTR
BSTR
long
LanguageType
BSTR
YesNoType
IGeneralFormRequest
IGeneralFormResult
VARIANT_BOOL
bstrPDFTemplate,
*pbstrFormOID,
*plFormVersion,
*peFormLanguage,
*pbstrIntermediates,
*peHasDirectSend,
**ppIGeneralFormRequest,
**ppIGeneralFormResult,
*pbStatus);
 
/images/arrow_right.png Calling argument description
[in] BSTR bstrPDFTemplate Either a full file name (path + name) of a previously saved PDF form or 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 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 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 **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.
 
/images/arrow_right.png 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.