and fills out a PDF based form system
 IGeneralFormRequest::SetRequest method |
|||
|---|---|---|---|
|
Sets the role and place information, as well as the processing parameters "storno" and "copy".
Note, that whenever the "storno" and/or "copy" parameters are set then the timestamp of the topmost form object reference (SetForm) must be defined that is > 0 otherwise an error will result in the IGeneralFormRequestManager::GetXML method. |
 |
||
| C/C++ calling syntax |
|||
| HRESULT SetRequest( | RoleType
PlaceType BSTR YesNoType YesNoType VARIANT_BOOL |
eRoleType,
ePlaceType, bstrRoleTitle, eIsStorno, eIsCopy, *pbStatus); |
|
| Calling argument description |
|||
| [in] RoleType | eRoleType | Defines the role category that the form producer is best categorized by.
If the form producer has role undefined by the role enumeration then use enRoleOther and additionally supply a role title with a description of the role. |
|
| [in] PlaceType | ePlaceType | Defines the principle place where the form producer is practicing. | |
| [in] BSTR | bstrRoleTitle | Optional role title/description of the form producer.
If a suitable predefined role can not be set then bstrRoleTitle is mandatory (use enRoleOther as role in that case) |
|
| [in] YesNoType | eIsStorno | Boolean value that defines the "storno" status of the form process.
eIsStorno should be false when the initial form infoset is produced. At this step the timestamp is generated and returned in the GeneralFormRequestManager::GetXML method. Whenever eIsStorno is true then the form timestamp must be set otherwise an error will result. |
|
| [in] YesNoType | eIsCopy | Boolean value that defines the "copy" status of the form process.
eIsCopy should be false when the initial XML infoset is produced. At this step the timestamp is generated and returned in the IGeneralFormRequestRequestManager::GetXML method. Whenever eIsCopy is true then the form timestamp must be set otherwise an error will result. |
|
| [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. | ||