> For the complete documentation index, see [llms.txt](https://sandbox-docs.verifone.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sandbox-docs.verifone.com/s-adk-5.1-programmers-guide/readme/files/dir_f9c8c0699850f5588903704d86bd63e7/dir_9f39dd86019fee8ad514daa97fcb3202/syslogcmd_8h.md).
# syslogcmd.h
[Enumerations](#enum-members) | [Functions](#func-members)
`#include "priv/logapi_base.h"`
Include dependency graph for syslogcmd.h:
[Go to the source code of this file.](/s-adk-5.1-programmers-guide/syslogcmd_8h_source.md)
| | |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Enumerations | |
| enum | SYSL\_ERROR {
SYSL\_E\_OK = 0, SYSL\_E\_PARAM = -1, SYSL\_E\_CONN = -2, SYSL\_E\_UNEXP = -3,
SYSL\_E\_NOT\_IMPL = -99
}
|
| enum | [SYSL\_SRC](#acf4ae1d193df756ada6ad21ca9fe3254) { [SSRC\_VERIX\_BUF](#acf4ae1d193df756ada6ad21ca9fe3254a79ffb724fbdaf4b711aba9aa30c1172e) = 0x2, [SSRC\_APPS](#acf4ae1d193df756ada6ad21ca9fe3254ac7659f14e617cfac1e4d3aac76a692eb) = 0x4, [SSRC\_ALL](#acf4ae1d193df756ada6ad21ca9fe3254a842201a8e810be8fa4b5c198684bfeea) = 0x6 } |
| enum | SYSL\_LVL {
SYSL\_LVL\_EMERG, SYSL\_LVL\_ALERT, SYSL\_LVL\_CRIT, SYSL\_LVL\_ERROR,
SYSL\_LVL\_WARN, SYSL\_LVL\_NOTICE, SYSL\_LVL\_INFO, SYSL\_LVL\_TRACE
}
|
| enum | config\_option {
ENABLED = 0, DESTINATION = 1, SERIAL\_COM = 2, UDP\_HOST = 3,
LOG\_LEVEL = 4, UDP\_PORT = 5, FILE\_NAME = 6, FILE\_BUF\_SIZE = 7,
LOG\_SOURCE = 8, SEND\_RETRIES = 9, MAX\_LOGFILE\_SIZE = 10, NUMBER\_OF\_FILES = 11,
LOG\_FORMAT = 12, FILTER\_OUT\_CONSOLE\_LOGS = 13, MAX\_ENUM\_COUNT = 14
}
|
| enum | [COMMUNICATION](#a3634f6fef0c62931e673162e0714d39c) { [COM](#a3634f6fef0c62931e673162e0714d39caaaabad2553753eb2aceaa31ab2ad3d72), [ETH](#a3634f6fef0c62931e673162e0714d39cadbc24c1d2cb5f08132fc9a0f7aa683ae), [FS](#a3634f6fef0c62931e673162e0714d39ca59e0bfb4f405c70dd8788b19d5084966), [USB](#a3634f6fef0c62931e673162e0714d39ca65f6b55fdc64778bf10632a795b97761) } |
| enum | { [LOGAPI\_SYSL\_BUFFER\_LEN](#a0411cd49bb5b71852cecd93bcbf0ca2daf49f701220e595ad6fd5f9ae64875362) = 50 } |
| | |
| --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Functions | |
| LOGAPI\_PUBLIC enum [SYSL\_ERROR](#a0eb0f037f3c642e27dd2464751c7d4dd) | [syslcmd\_set\_level](#a9b45919ef5fe9f2b4ec89ff27d19ec30) (enum [SYSL\_LVL](#a2d22a0b7aa8b36200053c3ac5a643d39) lvl) |
| | Sets level on syslog daemon side. More...
|
| LOGAPI\_PUBLIC enum [SYSL\_ERROR](#a0eb0f037f3c642e27dd2464751c7d4dd) | [syslcmd\_set\_source](#afa7176aab63ea25440d5790c64885caa) (enum [SYSL\_SRC](#acf4ae1d193df756ada6ad21ca9fe3254) src) |
| | Sets source of log messages. More...
|
| LOGAPI\_PUBLIC enum [SYSL\_ERROR](#a0eb0f037f3c642e27dd2464751c7d4dd) | [syslcmd\_set\_dest\_UDP](#ae5d5ce27ee87e076c762b06d8fe26fc5) (const char \*addr, int port) |
| | Sets UPD as destination for messages. More...
|
| LOGAPI\_PUBLIC enum [SYSL\_ERROR](#a0eb0f037f3c642e27dd2464751c7d4dd) | [syslcmd\_set\_dest\_COM](#a155d47993134d2694a06ffd000d06dd8) (int serial\_port) |
| | Sets serial as destination for messages. More...
|
| LOGAPI\_PUBLIC enum [SYSL\_ERROR](#a0eb0f037f3c642e27dd2464751c7d4dd) | [syslcmd\_set\_dest\_FILE](#aff55c12911bcfc4dceee1e717a904e88) (const char \*filename) |
| | Sets file as destination for messages. More...
|
| LOGAPI\_PUBLIC enum [SYSL\_ERROR](#a0eb0f037f3c642e27dd2464751c7d4dd) | [syslcmd\_apply\_config](#ae79e868aa5c9cd5cbcf2772c9938c8ce) (void) |
| | apply configuration to syslog daemon More...
|
| LOGAPI\_PUBLIC enum [SYSL\_ERROR](#a0eb0f037f3c642e27dd2464751c7d4dd) | [syslcmd\_set\_cfg\_str](#aa4b80452347490e05b502546792aadae) (enum [config\_option](#aa5ce2add12b42175db5dbab55d3c384c) option, const char \*sval) |
| | Sets string options(UDP host and file name) on syslog daemon side. More...
|
| LOGAPI\_PUBLIC enum [SYSL\_ERROR](#a0eb0f037f3c642e27dd2464751c7d4dd) | [syslcmd\_set\_cfg\_int](#a8fe51a2185b092cbdcd6e883b93248bf) (enum [config\_option](#aa5ce2add12b42175db5dbab55d3c384c) option, int ival) |
| | Sets integer options(others than UDP host and file name) on syslog daemon side. More...
|
| LOGAPI\_PUBLIC enum [SYSL\_ERROR](#a0eb0f037f3c642e27dd2464751c7d4dd) | [syslcmd\_get\_cfg\_str](#a94f13c3a6a608ba2c24ace72bbc2714c) (enum [config\_option](#aa5ce2add12b42175db5dbab55d3c384c) option, char \*sval) |
| | Returns string options(UDP host and file name) from syslog daemon side. More...
|
| LOGAPI\_PUBLIC enum [SYSL\_ERROR](#a0eb0f037f3c642e27dd2464751c7d4dd) | [syslcmd\_get\_cfg\_str2](#ace143cbc5c26fa1bada02589c97c5027) (enum [config\_option](#aa5ce2add12b42175db5dbab55d3c384c) option, char \*sval, unsigned int len) |
| | Returns string options(UDP host and file name) from syslog daemon side. More...
|
| LOGAPI\_PUBLIC enum [SYSL\_ERROR](#a0eb0f037f3c642e27dd2464751c7d4dd) | [syslcmd\_get\_cfg\_int](#a1665cdbed014c0926a02a242708c5234) (enum [config\_option](#aa5ce2add12b42175db5dbab55d3c384c) option, int \*ival) |
| | Returns integer options(others than UDP host and file name) on syslog daemon side. More...
|
### EnumerationType Documentation
### anonymousenum
anonymous enum
| | |
| ------------------------- | - |
| Enumerator | |
| LOGAPI\_SYSL\_BUFFER\_LEN | |
### COMMUNICATION
enum \[COMMUNICATION]\(#a3634f6fef0c62931e673162e0714d39c)
| | |
| ---------- | - |
| Enumerator | |
| COM | |
| ETH | |
| FS | |
| USB | |
### config\_option
enum \[config\_option]\(#aa5ce2add12b42175db5dbab55d3c384c)
| | |
| -------------------------- | - |
| Enumerator | |
| ENABLED | |
| DESTINATION | |
| SERIAL\_COM | |
| UDP\_HOST | |
| LOG\_LEVEL | |
| UDP\_PORT | |
| FILE\_NAME | |
| FILE\_BUF\_SIZE | |
| LOG\_SOURCE | |
| SEND\_RETRIES | |
| MAX\_LOGFILE\_SIZE | |
| NUMBER\_OF\_FILES | |
| LOG\_FORMAT | |
| FILTER\_OUT\_CONSOLE\_LOGS | |
| MAX\_ENUM\_COUNT | |
### SYSL\_ERROR
enum \[SYSL\_ERROR]\(#a0eb0f037f3c642e27dd2464751c7d4dd)
codes returned by syslcmd\_ API
| | |
| ------------------ | ------------------------------------------- |
| Enumerator | |
| SYSL\_E\_OK | operation succeeded |
| SYSL\_E\_PARAM | one or more paramteres are invalid |
| SYSL\_E\_CONN | no connection to daemon |
| SYSL\_E\_UNEXP | unexpected error while executing a function |
| SYSL\_E\_NOT\_IMPL | not implemented |
### SYSL\_LVL
enum \[SYSL\_LVL]\(#a2d22a0b7aa8b36200053c3ac5a643d39)
Enum denotes an upper level of log messages
| | |
| ----------------- | - |
| Enumerator | |
| SYSL\_LVL\_EMERG | |
| SYSL\_LVL\_ALERT | |
| SYSL\_LVL\_CRIT | |
| SYSL\_LVL\_ERROR | |
| SYSL\_LVL\_WARN | |
| SYSL\_LVL\_NOTICE | |
| SYSL\_LVL\_INFO | |
| SYSL\_LVL\_TRACE | |
### SYSL\_SRC
enum \[SYSL\_SRC]\(#acf4ae1d193df756ada6ad21ca9fe3254)
Denotes a source of log messages
| | |
| ---------------- | - |
| Enumerator | |
| SSRC\_VERIX\_BUF | |
| SSRC\_APPS | |
| SSRC\_ALL | |
### FunctionDocumentation
### syslcmd\_apply\_config()
LOGAPI\_PUBLIC enum \[SYSL\_ERROR]\(#a0eb0f037f3c642e27dd2464751c7d4dd) syslcmd\_apply\_config
apply configuration to syslog daemon
### syslcmd\_get\_cfg\_int()
LOGAPI\_PUBLIC enum \[SYSL\_ERROR]\(#a0eb0f037f3c642e27dd2464751c7d4dd) syslcmd\_get\_cfg\_int
Returns integer options(others than UDP host and file name) on syslog daemon side.
**Parameters**
\[in] **option** configuration option to get \[out] **ival** configuration options value
### syslcmd\_get\_cfg\_str()
LOGAPI\_PUBLIC enum \[SYSL\_ERROR]\(#a0eb0f037f3c642e27dd2464751c7d4dd) syslcmd\_get\_cfg\_str
Returns string options(UDP host and file name) from syslog daemon side.
**Parameters**
\[in] **option** configuration option to get \[out] **sval** configuration options value
### syslcmd\_get\_cfg\_str2()
LOGAPI\_PUBLIC enum \[SYSL\_ERROR]\(#a0eb0f037f3c642e27dd2464751c7d4dd) syslcmd\_get\_cfg\_str2
Returns string options(UDP host and file name) from syslog daemon side.
**Parameters**
\[in] **option** configuration option to get \[out] **sval** configuration options value \[in] **len** string value's buffer size
### syslcmd\_set\_cfg\_int()
LOGAPI\_PUBLIC enum \[SYSL\_ERROR]\(#a0eb0f037f3c642e27dd2464751c7d4dd) syslcmd\_set\_cfg\_int
Sets integer options(others than UDP host and file name) on syslog daemon side.
**Parameters**
\[in] **option** configuration option to set \[in] **ival** value to set
### syslcmd\_set\_cfg\_str()
LOGAPI\_PUBLIC enum \[SYSL\_ERROR]\(#a0eb0f037f3c642e27dd2464751c7d4dd) syslcmd\_set\_cfg\_str
Sets string options(UDP host and file name) on syslog daemon side.
**Parameters**
\[in] **option** configuration option to set \[in] **sval** value to set
### syslcmd\_set\_dest\_COM()
LOGAPI\_PUBLIC enum \[SYSL\_ERROR]\(#a0eb0f037f3c642e27dd2464751c7d4dd) syslcmd\_set\_dest\_COM
Sets serial as destination for messages.
**Parameters**
\[in] **serial\_port** COM port to use
### syslcmd\_set\_dest\_FILE()
LOGAPI\_PUBLIC enum \[SYSL\_ERROR]\(#a0eb0f037f3c642e27dd2464751c7d4dd) syslcmd\_set\_dest\_FILE
Sets file as destination for messages.
**Parameters**
\[in] **filename** file to write logs to
### syslcmd\_set\_dest\_UDP()
LOGAPI\_PUBLIC enum \[SYSL\_ERROR]\(#a0eb0f037f3c642e27dd2464751c7d4dd) syslcmd\_set\_dest\_UDP
Sets UPD as destination for messages.
**Parameters**
\[in] **addr** address of target host \[in] **port** port of target host
### syslcmd\_set\_level()
LOGAPI\_PUBLIC enum \[SYSL\_ERROR]\(#a0eb0f037f3c642e27dd2464751c7d4dd) syslcmd\_set\_level
Sets level on syslog daemon side.
**Parameters**
\[in] **lvl** upper level of log messages
### syslcmd\_set\_source()
LOGAPI\_PUBLIC enum \[SYSL\_ERROR]\(#a0eb0f037f3c642e27dd2464751c7d4dd) syslcmd\_set\_source
Sets source of log messages.
**Parameters**
\[in] **src** source of log messages
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://sandbox-docs.verifone.com/s-adk-5.1-programmers-guide/readme/files/dir_f9c8c0699850f5588903704d86bd63e7/dir_9f39dd86019fee8ad514daa97fcb3202/syslogcmd_8h.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.