 IGeneralFormRequestManager::Forms property |
 |
|
The GetForms property returns an instance of the IForms interface.
The IForms interface serves 2 purposes:
- The IForms::Search method searches and the iterator pair IForms::GetFirstObject / IForms::GetNextObject retrieve the found form space records. The form space is a hierarchical tree structure consisting of descriptive nodes. Each node in turn can hold other descriptive nodes and PDF form template files. Thus the form space is a concept to group the PDF forms inside a logical, hierarchical structure.
Each node and leaf of the form space is described by a mandatory medForms OID, a name, a Boolean value if it is a node or a leaf, and an optional UID, where UID stands for the unique company specific ID assigned by the Federal Statistical Office. The given OID always stems from the medForms OID space and is supplied as absolute OID or as shortened form (e.g. medforms.20.30.5050), where «medforms» is the abbreviation for the medForms base OID
- The IForms::StartUpdate / IForms::UpdateStatus methods allow to update and extend the above mentioned form space as well as the PDF forms itself. The asynchronous update process can be started at any time, concurrently to the normal processing. However, the COM module starts the process automatically if the last update is older than 14 days.
|
|
|
 Restful webservice calling syntax |
|
| [GET] |
/baseURL/IGeneralFormRequestManager/GetForms?param |
| [param] |
pIGeneralFormRequestManager= |
longValue
|
| [JSON result data] |
pIForms: |
longValue //interface address
|
| [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 |
|
| [get] HRESULT |
Forms( IForms **peForms );
|
|
| [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 |
|
| [out,retval] IForms |
**peForms |
|
|
|
| Remarks |
|
|
If SmartPointers are used than the function names and calls are rewritten by Microsoft into the form
|
|
|
|
