The ATL COM module generalInvoiceRequest is capable of
generating electronic and printed invoices & reminders
generating electronic and printed invoices & reminders
API browser of generalInvoiceRequest450 COM module
IGeneralInvoiceRequestManager::SetLogSettings method | |||||||||
---|---|---|---|---|---|---|---|---|---|
Sets the log setting preferences for the module.
The default for the log activity are: level=1, lMaxSizeKB=1000,eDoArchive=enNo, and the log settings are persistent via the log file itself. Note, that the log facility is a best effort system. If there is an error e.g. due to insufficient privileges to write the log entries then nothing is logged. |
|||||||||
Restful webservice calling syntax | |||||||||
[POST] | /baseURL/IGeneralInvoiceRequestManager/SetLogSettings | ||||||||
[JSON input data] | pIGeneralInvoiceRequestManager: lLogLevel: lMaxSizeKB: eDoArchive: bstrArchiveDir: |
longValue, //interface address longValue, longValue, longValue, "utf8StringValue" |
|||||||
[JSON result data] | pbStatus: | 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 SetLogSettings( | long
long YesNoType BSTR VARIANT_BOOL |
lLogLevel,
lMaxSizeKB, eDoArchive, bstrArchiveDir, *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] long | lLogLevel | The log activity level where
Any log level below 0 is corrected to 0. |
|||||||
[in] long | lMaxSizeKB | The maximum size in KB of the log file.
Any size below 1000 KB (= the default value) is corrected to the default value |
|||||||
[in] YesNoType | eDoArchive | eDoArchive defines if the log file is recycled once the maximum size is reached (enNo) or if the log file is archived (enYes) into the archive directory. | |||||||
[in] BSTR | bstrArchiveDir | Defines the base directory where log files are archived. bstrArchiveDir is only used if eDoArchive=enYes. If bstrArchiveDir is empty and eDoArchive=enYes then the place of the module is used as the base archive directory.
If the base archive directory or directories below have insufficient privileges to create directories or write files archiving is not done! |
|||||||
[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. | |||||||