pushAdminMessage COM module is a data
exchange system for treatment messages
exchange system for treatment messages
API browser of pushAdminMessage450 COM module
IPushAdminMessageManager::GetLogSettings method | |||||||||
---|---|---|---|---|---|---|---|---|---|
Get the log settings for the module. | |||||||||
Restful webservice calling syntax | |||||||||
[POST] | /baseURL/IPushAdminMessageManager/GetLogSettings | ||||||||
[JSON input data] | pIPushAdminMessageManager: | longValue, //interface address |
|||||||
[JSON result data] | plLogLevel: plMaxSizeKB: peDoArchive: pbstrArchiveDir: pbStatus: |
longValue, longValue, longValue, "utf8StringValue", 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 GetLogSettings( | long
long YesNoType BSTR VARIANT_BOOL |
*plLogLevel,
*plMaxSizeKB, *peDoArchive, *pbstrArchiveDir, *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 | |||||||||
[out] long | *plLogLevel | The log activity level where
|
|||||||
[out] long | *plMaxSizeKB | The maximum size in KB of the log file. | |||||||
[out] YesNoType | *peDoArchive | eDoArchive defines if the log file is recycled if the maximum size is reached (enNo) or if the log file is archived (enYes). | |||||||
[out] BSTR | *pbstrArchiveDir | The base directory where log files are archived. bstrArchiveDir is only defined if eDoArchive=enYes otherwise bstrArchiveDir is empty. | |||||||
[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. | |||||||