generating electronic and printed invoices & reminders
 IGeneralInvoiceRequest::SetRequest method |
|||
|---|---|---|---|
|
Sets the role and place information, the processing parameters "storno" and "copy" besides data language and optional remark
Note, that whenever the "storno" and/or "copy" parameters are set then the timestamp of the topmost object reference (SetInvoice or SetReminder) must be defined that is > 0 otherwise an error will result in the Finalize method. |
 |
||
| C/C++ calling syntax |
|||
| HRESULT SetRequest( | RoleType
PlaceType BSTR YesNoType YesNoType BSTR VARIANT_BOOL |
eRoleType,
ePlaceType, bstrRoleTitle, eIsStorno, eIsCopy, bstrRemark, *pbStatus); |
|
| Calling argument description |
|||
| [in] RoleType | eRoleType | Defines the role categories that the main provider is best categorized.
If the main provider has an other role than defined then use enRoleOther and additionally supply a role title with a description of the role |
|
| [in] PlaceType | ePlaceType | Defines the principle place where the main provider is applying the treatment | |
| [in] BSTR | bstrRoleTitle | Optional role title/description of the main provider.
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 invoice/reminder.
eIsStorno should be false when the initial invoice or reminder is produced. At this step the timestamp is generated and returned in the GeneralInvoiceRequestManager::Print and/or GeneralInvoiceRequestManager::GetXML method. Whenever eIsStorno is true then the invoice or reminder timestamp must be set otherwise an error will result. |
|
| [in] YesNoType | eIsCopy | Boolean value that defines the "copy" status of the invoice/reminder.
eIsCopy should be false when the initial invoice or reminder is produced. At this step the timestamp is generated and returned in the IGeneralInvoiceRequestManager::Print and/or IGeneralInvoiceRequestRequestManager::GetXML method. Whenever eIsCopy is true then the invoice or reminder timestamp must be set otherwise an error will result. |
|
| [in] BSTR | bstrRemark | An overall optional remark for the invoice/reminder
Note that the reminder text is printed instead of the remark if bstrReminderText is set in the SetReminder method. |
|
| [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. | ||