> 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/modules/group__mac/namespacevfimac.md). # vfimac [Typedefs](#typedef-members) | [Enumerations](#enum-members) | [Functions](#func-members) | | | | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Typedefs | | | typedef void(\* | [macEventCallback](#aa740ccdb24bc2dad5717ef65e33b0a24)) ([macEvent](#a3bc43cdb5f4033e625bb6dc7e1579d4b) event, const [vfiipc::JSObject](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.1_staging/classvfiipc_1_1_j_s_object.md) \&json) | | typedef void(\* | [macNotificationCallback](#ad2df18eb227eae3f9524fa9031c92d4a)) ([macNotifications](#aabd24d8a0b08ebc6a6da2c43b0ae2d9b) notification) | | | | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Enumerations | | | enum |

macError {
MAC\_ERR\_OK = 0, MAC\_ERR\_FAIL = -1, MAC\_ERR\_UNSUPPORTED = -2, MAC\_ERR\_LOCKED = -3,
MAC\_ERR\_TIMEOUT = -4, MAC\_ERR\_LIBNOTIFY = -5, MAC\_ERR\_APP\_NOT\_RUNNING = -6, MAC\_ERR\_WRONG\_APPID = -7,
MAC\_ERR\_NOT\_CP\_APP = -8, MAC\_ERR\_UNKNOWN = -9, MAC\_ERR\_CYCLE = -10, MAC\_ERR\_DEPENDS = -11,
MAC\_ERR\_MANIFEST = -12, MAC\_ERR\_IPC = -13, MAC\_ERR\_NO\_APP = -14, MAC\_ERR\_READY = -15,
MAC\_ERR\_ACTIVE = -16, MAC\_ERR\_STOP = -17, MAC\_ERR\_NO\_APPID = -18, MAC\_ERR\_PERMISSION = -19,
MAC\_ERR\_SERVICE = -20, MAC\_ERR\_VISIBLE = -21, MAC\_ERR\_DISABLED = -22, MAC\_ERR\_LAUNCH = -23,
MAC\_ERR\_RUNNING = -24, MAC\_ERR\_LAYOUT = -25, MAC\_ERR\_PARAMETER = -26, MAC\_ERR\_IGNORE = -27,
MAC\_ERR\_CANCELED = -28, MAC\_ERR\_EXISTS = -29, MAC\_ERR\_NO\_KEYS = -30, MAC\_ERR\_EXPECTED\_KEYS = -31,
MAC\_ERR\_ACCESS = -32, MAC\_ERR\_AVAILIBLE = -33, MAC\_ERR\_CPR\_DISABLED = -35, MAC\_ERR\_INVALID\_FORMAT = -36
}

| | enum | [macLaunchParams](#a3d1d0138ae66b9a9e03ae518de7ecf63) { [NONE](#a3d1d0138ae66b9a9e03ae518de7ecf63ac157bdf0b85a40d2619cbc8bc1ae5fe2) = 0, [KEEP\_IN\_BACKGROUND](#a3d1d0138ae66b9a9e03ae518de7ecf63a365b0d10413f98eb889815324f8baa8c) = 1 } | | enum |

macKeyboard {
MAC\_KBD\_OFF = (0<<0), MAC\_KBD\_ON = (1<<0), MAC\_KBD\_AUTO = (1<<1), MAC\_KBD\_NUMERIC = (1<<2),
MAC\_KBD\_ALPHANUMERIC = (1<<3), MAC\_KBD\_CAPITALIZED = (1<<4), MAC\_KBD\_LAST = (1<<5)
}

| | enum |

macEvent {
EVENT\_NONE = 0, EVENT\_MANIFEST\_UPDATE = 1, EVENT\_ACTIVATION\_UPDATE = 2, EVENT\_PARAMETER\_UPDATE = 3,
EVENT\_FOCUS\_UPDATE = 4, EVENT\_FOREGROUND = 5, EVENT\_BACKGROUND = 6, EVENT\_CP\_STARTED = 7,
EVENT\_CP\_STOPPED = 8, EVENT\_BOOT\_COMPLETED = 9, EVENT\_LAST = 10
}

| | enum |

macNotifications {
NOTIFICATION\_NONE = (0<<0), NOTIFICATION\_MANIFEST\_RESCAN = (1<<0), NOTIFICATION\_ACTIVATION\_CFG\_UPDATE = (1<<1), NOTIFICATION\_PARAMETER\_CFG\_UPDATE = (1<<2),
NOTIFICATION\_CP\_START = (1<<3), NOTIFICATION\_CP\_STOP = (1<<4), NOTIFICATION\_LAST = (1<<6), NOTIFICATION\_ALL = 0xFFFF
}

| | enum | [systemNotificationPriority](#af8d28bc2c3fa0398b42f840088f59a4b) { [SYSTEM\_NOTIFICATION\_INFO](#af8d28bc2c3fa0398b42f840088f59a4bae45a50bf56795bda968dfc1694ad2871) = 1, [SYSTEM\_NOTIFICATION\_WARNING](#af8d28bc2c3fa0398b42f840088f59a4ba4313068313501b2088a0336442126a4a) = 2, [SYSTEM\_NOTIFICATION\_CRITICAL](#af8d28bc2c3fa0398b42f840088f59a4ba6951f9532ee21d9a68bf0e4f1307d03b) = 3 } | | | | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Functions | | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysSetEventCallback](#ae4108c74c16f2f512405ba326843109a) ([macEvent](#a3bc43cdb5f4033e625bb6dc7e1579d4b) event, [macEventCallback](#aa740ccdb24bc2dad5717ef65e33b0a24) cb) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysNotificationCallback](#a21f532b6bb03873e6927390c19840c67) ([macNotificationCallback](#ad2df18eb227eae3f9524fa9031c92d4a) cb, long notification\_mask) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysNotificationCallback](#adb02617beacae56d66f518a263ce0890) ([macNotificationCallback](#ad2df18eb227eae3f9524fa9031c92d4a) cb=NULL, [macNotifications](#aabd24d8a0b08ebc6a6da2c43b0ae2d9b) notification=[NOTIFICATION\_NONE](#aabd24d8a0b08ebc6a6da2c43b0ae2d9ba5cc432d77c6eb1abbe3f89d4f895f778)) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysShowDesktop](#a404d8e38300385724b2d2ed306df863e) () | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysShowControlPanel](#a395a73335aa92641a3ac0967fc0bb200) () | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysShowPowerControlPanel](#a085b2f637d5f82e4ee2812baf24eba46) () | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysShowPrevApp](#a40e24a74e4f3dc63f080b34b0bb6c7de) () | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysLaunchAppid](#a77748eeae43d8b50145564d0022ad886) (const std::string \&appid, const std::vector< std::string > \&args, const std::map< std::string, std::string > \&envs, int params=0) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysLaunchAppid](#a17fee224cba3c5bfaf8835fbda157cc3) (const std::string \&appid, const std::vector< std::string > \&args, int params) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysLaunchAppid](#a53a3ccda2cdc2d39f2c618015ea81efb) (const std::string \&appid, const std::vector< std::string > \&args) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysLaunchAppid](#aa3c091d3bd20d0131c5f50318cd0750e) (const std::string \&appid) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysLaunchApp](#a52ed11c68234a6abcf53fa5edd596729) (const std::string \&appname, const std::vector< std::string > \&args) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysLaunchApp](#a5b1e0d2f61a93565ac1f1f2d89d4caf3) (const std::string \&appname) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysRelaunchApps](#a5b63071e5232000be8cd04e2950b28b2) () | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysIsRunning](#aae05286692566c22ef2d18a69748c5fe) (const std::string \&appid, bool \&running) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysShowProgress](#abb5ddef3187ac018cda433a3aec2c6fb) (const std::string \&info, size\_t percent) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysSetAppid](#abcf911819fbee784ef245fe34aa9572c) (const std::string \&appid) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysUnSetAppid](#a738e18eb97f53b402e01c6ee391b2607) () | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysChangeLayout](#aa54bee100e8df7bab8868a0c6b81bc67) (const std::string \&layoutname, bool statusbar=true, bool keyboard=false) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysChangeLayout](#a868378044b45895f8c85d0530c482a9e) (const std::string \&layoutname, bool statusbar) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysAssignToLayout](#aad01e467699aabea2fa64b588ede1fec) (const std::string \&appid, const std::string \®ion) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysFullscreenMode](#a56bd229ab93be9b2ee7ae2f95d10c166) (bool enable) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysStatusbar](#a9c942ac576c34a0e8dbd8cd69935a807) (bool visible) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysGetCPRState](#a924f920dc0fd9b34e91c6e57bd97816c) (bool \&active) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysGetCPAppRootDir](#a0d95ca7aac6a37040b0e2135d9f134d1) (std::string \&path) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysGetWMState](#ad031802bca1577454ee78a31122bde6d) (bool \&active) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysStatusbarState](#ac3325831385c4e7755c3d96575db9496) (bool \&visible) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysSetStatusbarValues](#a6c72ec8391307ac42e3c9d044eac36e2) (const std::map< std::string, std::string > \&values) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysGetStatusbarValues](#a443df02ff6897b4a9e6cb5973f5842b2) (std::map< std::string, std::string > \&values) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysStatusbarRefresh](#a6f771d3743e177bce7b7d79c26cf3036) () | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysVirtualKeyboard](#a287906c2724d813bb1eb0ad1f3b4f18a) ([macKeyboard](#a7ecd7d8b8c98bd60b3a7d95dc5da7c5f) mode) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysVirtualKeyboard](#acb5c31824823ba4b9708f41f86a3e4f0) (int mode) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysLockLayout](#a1f0513c597f95e860f0d4e516d72b364) (bool enable) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysInForeground](#a438d8362980527e345759c52a2615071) (std::string \&appid) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysInForeground](#afd762089e189223f837321ceb76ba9ba) (bool \&visible) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysToForeground](#a424b735dc0296a43429f6dfeab802fa4) (const std::string \&appid) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysToForground](#a1ac2b7ae5456bc7a0e543804f92f890a) (const std::string \&appid) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysStopAppid](#a57f7a1edb91c7479e4c2b2916a252822) (const std::string \&appid) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysStopAppname](#a54ba5d09eeee6974f08950ae922c1896) (const std::string \&appname) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysStopAllUserApps](#a6b24cb5e42ba92f571a4f000e2ed0230) () | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysStopOtherApps](#ad5c53e66bd56f6368628fbbeaa514622) () | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysGetAppList](#a807e4d61017fe99f6f6c66a8bd37ad08) ([vfiipc::JSObject](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.1_staging/classvfiipc_1_1_j_s_object.md) \&applist) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysScanManifests](#aec38c483c58974ddb58d576d9f7ac2f0) () | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysSetCPEnvData](#a3cb1620e29b7920b2b53560c1cae71fe) (const [vfiipc::JSObject](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.1_staging/classvfiipc_1_1_j_s_object.md) \&envs) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysInstallCPApp](#a86f520239eb2af7b49b1bc31dfc20906) (const std::string \&path) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysLaunchCPAppFromDesktop](#a509d985b46d2fe8d772bd749888fd1ab) (const std::string \&trigger\_id, const std::vector< std::string > \¶m) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysLaunchCPAppFromDesktop](#a188f9500b7eff15c4e9761c26b7e6641) (const std::string \&trigger\_id, const [vfiipc::JSObject](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.1_staging/classvfiipc_1_1_j_s_object.md) \¶m) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysLaunchCPAppFromDesktopSync](#aff611b7f21a2748fdc138db0718a481b) (const std::string \&trigger\_id, const [vfiipc::JSObject](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.1_staging/classvfiipc_1_1_j_s_object.md) \¶m, int flags=0) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysLaunchCPAppByTrigger](#a86cff41093ff1ab578ff1c54f47c5062) (const std::string \&appid, const std::string \&trigger\_id, const [vfiipc::JSObject](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.1_staging/classvfiipc_1_1_j_s_object.md) \¶m, unsigned int flags) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysInvokeCPAppAction](#a45f53838cafde90263046e5844717399) (const std::string \&appid, const std::string \&name, int display\_id=0, unsigned int flags=0) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysGetGUIRegionId](#a5a32e6fc3ca601108ec200e0bebf10a1) (const std::string \&appid, int \&gui\_region\_id) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [sysStopAllCPApps](#a9dea7108a3a1efc9a1cc087e18548c59) () | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) int | [systemNotificationAdd](#ac4a12edca6083bfb03386f390d67bc3d) ([systemNotificationPriority](#af8d28bc2c3fa0398b42f840088f59a4b) p, const std::string \&message, bool sticky=false) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [systemNotificationRemove](#a4aa74ec3d2bd8a53334045452b21820f) (int id) | | [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) [macError](#a343256ae5f150542a1f6a38fcaca216c) | [systemNotificationList](#a49a2afa866d86f54ab20603abcb7eb45) (std::list< int > \&list) | | const [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) char \* | [sysMac\_GetVersion](#a2e646f58a5f98e1b01ccae0a576ab8cf) () | | const [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) char \* | [sysLibMac\_GetVersion](#a9145ab384964062fa95dd07ad6cc7480) () | ### DetailedDescription Verifone Multi Application Controller (vfimac) namespace ### TypedefDocumentation ### macEventCallback typedef void(\\\* macEventCallback) (\[macEvent]\(#a3bc43cdb5f4033e625bb6dc7e1579d4b) event, const [vfiipc::JSObject](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.1_staging/classvfiipc_1_1_j_s_object.md) \&json) MAC event callback. This callback gets invoked when corresponding event occurs **Parameters** \[in] **json** JSON encoded event information {% hint style="info" %} Callback will be invoked sequentially for every event one by one in sequence {% endhint %} ### macNotificationCallback typedef void(\\\* macNotificationCallback) (\[macNotifications]\(#aabd24d8a0b08ebc6a6da2c43b0ae2d9b) notification) MAC notification callback. This callback gets invoked when corresponding event occurs **Parameters** \[in] **notification** macNotifications event identifier {% hint style="info" %} Callback will be invoked sequentially for every event one by one in sequence please see macNotifications for reference {% endhint %} ### EnumerationType Documentation ### macError enum \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) Error codes returned by MAC APIs | | | | --------------------------- | --------------------------------------------------- | | Enumerator | | | MAC\_ERR\_OK | Success | | MAC\_ERR\_FAIL | Generic error | | MAC\_ERR\_UNSUPPORTED | Function is not supported | | MAC\_ERR\_LOCKED | Layout is locked | | MAC\_ERR\_TIMEOUT | Timeout | | MAC\_ERR\_LIBNOTIFY | IPC error | | MAC\_ERR\_APP\_NOT\_RUNNING | Application is not running | | MAC\_ERR\_WRONG\_APPID | Wrong/unknown application id | | MAC\_ERR\_NOT\_CP\_APP | No matching CP application | | MAC\_ERR\_UNKNOWN | Unknown command | | MAC\_ERR\_CYCLE | Manifest dependency cycle detected | | MAC\_ERR\_DEPENDS | Manifest has missing dependency | | MAC\_ERR\_MANIFEST | Manifest validation error | | MAC\_ERR\_IPC | IPC error | | MAC\_ERR\_NO\_APP | No matching application | | MAC\_ERR\_READY | MAC is not ready | | MAC\_ERR\_ACTIVE | Application is not activate on this terminal | | MAC\_ERR\_STOP | Can't stop application | | MAC\_ERR\_NO\_APPID | No matching appid | | MAC\_ERR\_PERMISSION | Permission error | | MAC\_ERR\_SERVICE | Application is a service | | MAC\_ERR\_VISIBLE | Action not allowed while application is not visible | | MAC\_ERR\_DISABLED | This feature is disabled in MAC configuration file | | MAC\_ERR\_LAUNCH | Error during application launch | | MAC\_ERR\_RUNNING | MAC is not running | | MAC\_ERR\_LAYOUT | Layout doesn't exist | | MAC\_ERR\_PARAMETER | Parameter error | | MAC\_ERR\_IGNORE | Command was ignored due to configuration | | MAC\_ERR\_CANCELED | Canceled by user | | MAC\_ERR\_EXISTS | Doesn't exists | | MAC\_ERR\_NO\_KEYS | Keys are not available | | MAC\_ERR\_EXPECTED\_KEYS | No information on expected keys | | MAC\_ERR\_ACCESS | No access | | MAC\_ERR\_AVAILIBLE | Not available | | MAC\_ERR\_CPR\_DISABLED | Commerce Platform Runtime is disabled | | MAC\_ERR\_INVALID\_FORMAT | Invalid command format | ### macEvent enum \[macEvent]\(#a3bc43cdb5f4033e625bb6dc7e1579d4b) MAC events | | | | ------------------------- | --------------------------------------- | | Enumerator | | | EVENT\_NONE | no events occurred | | EVENT\_MANIFEST\_UPDATE | manifest list was updated | | EVENT\_ACTIVATION\_UPDATE | deprecated | | EVENT\_PARAMETER\_UPDATE | deprecated | | EVENT\_FOCUS\_UPDATE | focus switched to different application | | EVENT\_FOREGROUND | application transitioned to foreground | | EVENT\_BACKGROUND | application transitioned to background | | EVENT\_CP\_STARTED | CP application started | | EVENT\_CP\_STOPPED | CP application stopped | | EVENT\_BOOT\_COMPLETED | Boot completed | | EVENT\_LAST | placeholder | ### macKeyboard enum \[macKeyboard]\(#a7ecd7d8b8c98bd60b3a7d95dc5da7c5f) Virtual keyboard modes | | | | ---------------------- | --------------------------------------------------------------- | | Enumerator | | | MAC\_KBD\_OFF | permanently disable virtual keyboard | | MAC\_KBD\_ON | permanently enable virtual keyboard | | MAC\_KBD\_AUTO | activate automatic mode for both numeric and alphanumeric input | | MAC\_KBD\_NUMERIC | activate automatic mode only for numeric input | | MAC\_KBD\_ALPHANUMERIC | activate automatic mode only for alphanumeric input | | MAC\_KBD\_CAPITALIZED | alphanumeric keyboard will appear capitalized | | MAC\_KBD\_LAST | placeholder | ### macLaunchParams enum \[macLaunchParams]\(#a3d1d0138ae66b9a9e03ae518de7ecf63) Application execution flags | | | | -------------------- | ------------------------------ | | Enumerator | | | NONE | No special flags | | KEEP\_IN\_BACKGROUND | Keep application in background | ### macNotifications enum \[macNotifications]\(#aabd24d8a0b08ebc6a6da2c43b0ae2d9b) MAC notifications | | | | ------------------------------------- | ------------------------------------------ | | Enumerator | | | NOTIFICATION\_NONE | no events occurred | | NOTIFICATION\_MANIFEST\_RESCAN | manifest list was updated | | NOTIFICATION\_ACTIVATION\_CFG\_UPDATE | deprecated | | NOTIFICATION\_PARAMETER\_CFG\_UPDATE | deprecated | | NOTIFICATION\_CP\_START | CP application started | | NOTIFICATION\_CP\_STOP | CP application stopped | | NOTIFICATION\_LAST | placeholder | | NOTIFICATION\_ALL | register callback for all available events | ### systemNotificationPriority enum \[systemNotificationPriority]\(#af8d28bc2c3fa0398b42f840088f59a4b) SYSTEM notifications priority | | | | ------------------------------ | ----------------- | | Enumerator | | | SYSTEM\_NOTIFICATION\_INFO | Info severity | | SYSTEM\_NOTIFICATION\_WARNING | Warning severity | | SYSTEM\_NOTIFICATION\_CRITICAL | Critical severity | ### FunctionDocumentation ### sysAssignToLayout() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysAssignToLayout Assign application to certain region in layout **Parameters** \[in] **appid** application id from manifest file \[in] **region** region name from layout file #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_NO\_APPID](#a343256ae5f150542a1f6a38fcaca216ca9bb50ccba3958e9b7fda61d3ac05534c) unknown application id {% hint style="info" %} This API is needed for split screen mode {% endhint %} ### sysChangeLayout()\[1/2] [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysChangeLayout Change layout **Parameters** \[in] **layoutname** layout name from layout.ini file \[in] **statusbar** layout name with -sb suffix #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked ### sysChangeLayout()\[2/2] [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysChangeLayout Change layout **Parameters** \[in] **layoutname** layout name from layout.ini file \[in] **statusbar** layout name with -sb suffix \[in] **keyboard** layout name with -kb suffix #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked ### sysFullscreenMode() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysFullscreenMode Enter/leave full screen mode **Parameters** \[in] **enable** #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked [MAC\_ERR\_VISIBLE](#a343256ae5f150542a1f6a38fcaca216ca0ed934fa7a34568e74061ef14dfe3958) application is not currently visible {% hint style="info" %} Will switch layout to full screen one {% endhint %} #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a30). ### sysGetAppList() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysGetAppList Get information about available application **Parameters** \[out] **applist** #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error {% hint style="info" %} payload example: \[unsupported block] {% endhint %} #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a32). ### sysGetCPAppRootDir() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysGetCPAppRootDir Get path to Commerce Platform application root directory **Parameters** \[out] **path** path to Commerce Platform application root directory #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_CPR\_DISABLED](#a343256ae5f150542a1f6a38fcaca216cad1f788f290b62d4889261290c009f40a) CPR is disabled #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a66). ### sysGetCPRState() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysGetCPRState Commerce Platform Runtime state **Parameters** \[out] **active** #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error {% hint style="info" %} CPR will be inactive if no CP apps are installed or libcpr is missing on the system. {% endhint %} ### sysGetGUIRegionId() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysGetGUIRegionId Returns GUI region id used by application **Parameters** \[in] **appid** application id from manifest file \[in] **gui\_region\_id** GUI region id #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error [MAC\_ERR\_PARAMETER](#a343256ae5f150542a1f6a38fcaca216ca75777560e490e9383775482ac3bc245d) wrong parameter passed [MAC\_ERR\_NOT\_CP\_APP](#a343256ae5f150542a1f6a38fcaca216ca13ecf9a9db7593cabe3ca09c3496c17b) no CP application to launch #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a48). ### sysGetStatusbarValues() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysGetStatusbarValues Obtain value map from statusbar.html **Parameters** \[out] **values** value map from statusbar #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error {% hint style="info" %} This API can be used to add extra icons to statusbar. This API is useful in case custom MAC resources are used. {% endhint %} #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a42). ### sysGetWMState() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysGetWMState Windows Management state **Parameters** \[out] **active** #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error {% hint style="info" %} Windows Management is ON on devices with hardware display or remote display. {% endhint %} ### sysInForeground()\[1/2] [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysInForeground Allows to check if application is currently visible **Parameters** \[out] **visible** #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error ### sysInForeground()\[2/2] [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysInForeground Returns appid of currently visible application **Parameters** \[out] **appid** #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a49). ### sysInstallCPApp() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysInstallCPApp Install Commerce Platform application **Parameters** \[in] **path** path to CPA package which should be installed #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error [MAC\_ERR\_PARAMETER](#a343256ae5f150542a1f6a38fcaca216ca75777560e490e9383775482ac3bc245d) wrong parameter passed [MAC\_ERR\_ACCESS](#a343256ae5f150542a1f6a38fcaca216cafb7c2c54548ff09323602f8a6376fd01) installation package is not accessible [MAC\_ERR\_NOT\_CP\_APP](#a343256ae5f150542a1f6a38fcaca216ca13ecf9a9db7593cabe3ca09c3496c17b) no CP application to install [MAC\_ERR\_CPR\_DISABLED](#a343256ae5f150542a1f6a38fcaca216cad1f788f290b62d4889261290c009f40a) CPR is disabled {% hint style="info" %} Enable CPR logging channel to see installation log. {% endhint %} #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a55). ### sysInvokeCPAppAction() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysInvokeCPAppAction Allows to invoke action inside CP app context **Parameters** \[in] **appid** application id from manifest file \[in] **name** action name \[in] **display\_id** GUI display identifier \[in] **flags** for future use #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error [MAC\_ERR\_PARAMETER](#a343256ae5f150542a1f6a38fcaca216ca75777560e490e9383775482ac3bc245d) wrong parameter passed [MAC\_ERR\_NOT\_CP\_APP](#a343256ae5f150542a1f6a38fcaca216ca13ecf9a9db7593cabe3ca09c3496c17b) no CP application to launch [MAC\_ERR\_CPR\_DISABLED](#a343256ae5f150542a1f6a38fcaca216cad1f788f290b62d4889261290c009f40a) CPR is disabled {% hint style="info" %} API can be used for graceful API shutdown, if there is action which supports this. {% endhint %} #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a60). ### sysIsRunning() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysIsRunning Check if application is currently running **Parameters** \[in] **appid** application id from manifest file \[out] **running** running/not running #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error [MAC\_ERR\_NO\_APPID](#a343256ae5f150542a1f6a38fcaca216ca9bb50ccba3958e9b7fda61d3ac05534c) unknown application id #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a45). ### sysLaunchApp()\[1/2] [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysLaunchApp Launch an application by application name **Parameters** \[in] **appname** application name from manifest file #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error ### sysLaunchApp()\[2/2] [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysLaunchApp Launch an application by application name **Parameters** \[in] **appname** application name from manifest file \[in] **args** arguments to be passed to application #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error ### sysLaunchAppid()\[1/4] [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysLaunchAppid Launch an application by application id **Parameters** \[in] **appid** application id from manifest file #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error ### sysLaunchAppid()\[2/4] [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysLaunchAppid Launch an application by application id **Parameters** \[in] **appid** application id from manifest file \[in] **args** arguments to be passed to application #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error ### sysLaunchAppid()\[3/4] [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysLaunchAppid Launch an application by application id **Parameters** \[in] **appid** application id from manifest file \[in] **args** arguments to be passed to application \[in] **envs** environments to be passed to application \[in] **params** mask with launching parameters from macLaunchParams enum #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a46). ### sysLaunchAppid()\[4/4] [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysLaunchAppid Launch an application by application id **Parameters** \[in] **appid** application id from manifest file \[in] **args** arguments to be passed to application \[in] **params** mas with launching parameters from macLaunchParams enum #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error ### sysLaunchCPAppByTrigger() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysLaunchCPAppByTrigger Will execute all CP applications, which are registered for certain trigger identifier **Parameters** \[in] **appid** application id from manifest file (can be "\*" for broadcast mode or "1" for unicast mode) \[in] **trigger\_id** trigger identifier \[in] **param** parameters will be passed to CP application in cp\_notifyParam field \[in] **flags** flags passed to CP app in cp\_notifyFlags field #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error [MAC\_ERR\_PARAMETER](#a343256ae5f150542a1f6a38fcaca216ca75777560e490e9383775482ac3bc245d) wrong parameter passed [MAC\_ERR\_NOT\_CP\_APP](#a343256ae5f150542a1f6a38fcaca216ca13ecf9a9db7593cabe3ca09c3496c17b) no CP application to launch [MAC\_ERR\_CPR\_DISABLED](#a343256ae5f150542a1f6a38fcaca216cad1f788f290b62d4889261290c009f40a) CPR is disabled {% hint style="info" %} if appid is equal to "\*", this will invoke broadcast mode. In this case all CP applications with matching trigger identifier will be launched one by one. Launching sequence happens according to CP application priorities. if appid is equal to "1", this will invoke unicast mode. In this case only one CP applications with highest priority and matching trigger identifier will be launched. in all other cases only one application with matching appid will be launched. {% endhint %} #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a53). ### sysLaunchCPAppFromDesktop()\[1/2] [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysLaunchCPAppFromDesktop MAC will generate desktop with icons for every CP application, which has matching trigger. **Parameters** \[in] **trigger\_id** trigger identifier \[in] **param** parameters will be passed to CP application in cp\_notifyParam field #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error [MAC\_ERR\_PARAMETER](#a343256ae5f150542a1f6a38fcaca216ca75777560e490e9383775482ac3bc245d) wrong parameter passed [MAC\_ERR\_NOT\_CP\_APP](#a343256ae5f150542a1f6a38fcaca216ca13ecf9a9db7593cabe3ca09c3496c17b) no matching CP application [MAC\_ERR\_CPR\_DISABLED](#a343256ae5f150542a1f6a38fcaca216cad1f788f290b62d4889261290c009f40a) CPR is disabled {% hint style="info" %} This API is asynchronous. {% endhint %} #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a52). ### sysLaunchCPAppFromDesktop()\[2/2] [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysLaunchCPAppFromDesktop MAC will generate desktop with icons for every CP application, which has matching trigger. **Parameters** \[in] **trigger\_id** trigger identifier \[in] **param** parameters will be passed to CP application in cp\_notifyParam field #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error [MAC\_ERR\_PARAMETER](#a343256ae5f150542a1f6a38fcaca216ca75777560e490e9383775482ac3bc245d) wrong parameter passed [MAC\_ERR\_NOT\_CP\_APP](#a343256ae5f150542a1f6a38fcaca216ca13ecf9a9db7593cabe3ca09c3496c17b) no matching CP application {% hint style="info" %} This API is asynchronous. {% endhint %} ### sysLaunchCPAppFromDesktopSync() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysLaunchCPAppFromDesktopSync MAC will generate desktop with icons for every CP application, which has matching trigger. **Parameters** \[in] **trigger\_id** trigger identifier \[in] **param** parameters will be passed to CP application in cp\_notifyParam field \[in] **flags** flags passed to CP app in cp\_notifyFlags field #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) application was launched successfully [MAC\_ERR\_CANCELED](#a343256ae5f150542a1f6a38fcaca216ca495bae09e1bc1aa9559aa0f7ec8668c0) desktop was canceled by user [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) IPC error [MAC\_ERR\_CPR\_DISABLED](#a343256ae5f150542a1f6a38fcaca216cad1f788f290b62d4889261290c009f40a) CPR is disabled {% hint style="info" %} This API is synchronous. It will exit only after application is launched or desktop is canceled. {% endhint %} #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a51). ### sysLibMac\_GetVersion() const [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) char\\\* vfimac::sysLibMac\_GetVersion returns a zero-terminated string with version and build information of MAC library in ADK version string format: major.minor.patch-build, e.g. "1.2.3-4" #### Returns version string #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a28). ### sysLockLayout() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysLockLayout Lock/unlock the layout. **Parameters** \[in] **enable** enable/disable layout lock {% hint style="info" %} Prevents other application from changing the layout (e.g. requesting full screen or virtual keyboard). Prevents from showing the application desktop. Typically this is being called when applications do user processing and don't want the layout to be changed. {% endhint %} #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is already locked [MAC\_ERR\_VISIBLE](#a343256ae5f150542a1f6a38fcaca216ca0ed934fa7a34568e74061ef14dfe3958) application is not currently visible (in this case it can't lock layout) #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a31). ### sysMac\_GetVersion() const [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) char\\\* vfimac::sysMac\_GetVersion returns a zero-terminated string with version and build information of MAC in ADK version string format: major.minor.patch-build, e.g. "1.2.3-4" #### Returns version string #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a27). ### sysNotificationCallback()\[1/2] [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysNotificationCallback Register notification callback. **Parameters** \[in] **cb** notification callback to be invoked \[in] **notification\_mask** mask with requested events {% hint style="info" %} Set callback to NULL to disable callback please see macNotifications for reference {% endhint %} #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error ### sysNotificationCallback()\[2/2] [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysNotificationCallback Register notification callback. **Parameters** \[in] **cb** notification callback to be invoked \[in] **notification** mask with requested events {% hint style="info" %} Set callback to NULL to disable callback please see macNotifications for reference {% endhint %} #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error ### sysRelaunchApps() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysRelaunchApps Initialize relaunch process #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error {% hint style="info" %} after invoking this API, MAC will first stop all applications. After that all applications with autolaunch sections in manifest files, will be launched. this API should bring terminal to clean state (same as after boot) {% endhint %} #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a29). ### sysScanManifests() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysScanManifests Request MAC to rescan all folders for new manifest files #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error [MAC\_ERR\_CYCLE](#a343256ae5f150542a1f6a38fcaca216ca388507f8c281d588adfecda0ea957dae) manifest dependency cycle is detected [MAC\_ERR\_DEPENDS](#a343256ae5f150542a1f6a38fcaca216caeb1198ea1741ae185ba82873527fc923) manifests are missing dependencies {% hint style="info" %} Typically this is done after a SW update and new application installation. {% endhint %} #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a61). ### sysSetAppid() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysSetAppid This API is used to register you application in MAC. After invokig this API, MAC will create new GUI region for application and set correct environment variables. **Parameters** \[in] **appid** application id from manifest file #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success {% hint style="info" %} This API is needed for specific usecase. Not intended for general use. This API is usefull when application was launched by SI, but it still wants to interract with MAC. Application needs to call sysUnSetAppid before exiting, to avoid resource leek. Be sure to invoke this API before using any ADK-GUI API calls. {% endhint %} ### sysSetCPEnvData() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysSetCPEnvData Set environment values for CPR applications **Parameters** \[in] **envs** environment values #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error {% hint style="info" %} Values will be accessible to CP application via ARGV\["cp\_envData"]. Values are available only to CPR applications. {% endhint %} #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a54). ### sysSetEventCallback() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysSetEventCallback Register notification callback. **Parameters** \[in] **cb** notification callback to be invoked \[in] **event** requested event {% hint style="info" %} Set callback to NULL to disable callback please see macNotifications for reference {% endhint %} #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a11). ### sysSetStatusbarValues() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysSetStatusbarValues Sets value map to statusbar.html **Parameters** \[in] **values** value map, which will be passed to statusbar.html #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error {% hint style="info" %} This API can be used to add extra icons to statusbar. This API is useful in case custom MAC resources are used. {% endhint %} #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a43). ### sysShowControlPanel() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysShowControlPanel Show MAC Control Panel #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a64). ### sysShowDesktop() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysShowDesktop Show MAC desktop #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a62). ### sysShowPowerControlPanel() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysShowPowerControlPanel Show MAC Power Control Panel #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a63). ### sysShowPrevApp() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysShowPrevApp Show previous visible application {% hint style="info" %} Will show previously visible application. will show desktop if visibility stack is empty {% endhint %} #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error ### sysShowProgress() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysShowProgress Shows progress screen during application startup **Parameters** \[in] **info** message to be reported on screen \[in] **percent** boot progress (0-100%) #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error [MAC\_ERR\_VISIBLE](#a343256ae5f150542a1f6a38fcaca216ca0ed934fa7a34568e74061ef14dfe3958) application is not currently visible #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a7). ### sysStatusbar() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysStatusbar Set statusbar state **Parameters** \[in] **visible** #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error {% hint style="info" %} This configuration is stored per application {% endhint %} #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a40). ### sysStatusbarRefresh() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysStatusbarRefresh Enforce MAC statusbar refresh #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a41). ### sysStatusbarState() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysStatusbarState Get current statusbar state **Parameters** \[out] **visible** #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error {% hint style="info" %} This configuration is stored per application {% endhint %} #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a44). ### sysStopAllCPApps() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysStopAllCPApps Stop all Commerce Platform applications #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a58). ### sysStopAllUserApps() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysStopAllUserApps Stop all user applications #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error {% hint style="info" %} All applications started by MAC (users usr1-usr15) will be stopped. {% endhint %} #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a57). ### sysStopAppid() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysStopAppid Stops application by appid **Parameters** \[in] **appid** #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error [MAC\_ERR\_APP\_NOT\_RUNNING](#a343256ae5f150542a1f6a38fcaca216ca2b3e6bb894a825d49a856f7d78fbaace) application is not running #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a59). ### sysStopAppname() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysStopAppname Stops application by application name **Parameters** \[in] **appname** #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error [MAC\_ERR\_APP\_NOT\_RUNNING](#a343256ae5f150542a1f6a38fcaca216ca2b3e6bb894a825d49a856f7d78fbaace) application is not running ### sysStopOtherApps() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysStopOtherApps Stop all user applications, except for calling application #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error {% hint style="info" %} All applications started by MAC (users usr1-usr15) will be stopped. Calling application will remain active. This API is useful if you want to avoid any kind of interference from other applications. {% endhint %} #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a56). ### systemNotificationAdd() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) int vfimac::systemNotificationAdd Add new system notification **Parameters** \[in] **p** notification priority like systemNotificationPriority::SYSTEM\_NOTIFICATION\_INFO systemNotificationPriority::SYSTEM\_NOTIFICATION\_WARNING systemNotificationPriority::SYSTEM\_NOTIFICATION\_CRITICAL \[in] **message** notification message \[in] **sticky** notification optional parameter. Can't be removed via GUI if 'true'. #### Returns negative value indicates an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum positive value (ID) indicates success. #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a20). ### systemNotificationList() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::systemNotificationList List of current notifications **Parameters** \[out] **list** notifications std::list\ #### Returns returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a24). ### systemNotificationRemove() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::systemNotificationRemove Remove notification **Parameters** \[in] **id** notification id to remove #### Returns returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a25). ### sysToForeground() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysToForeground Bring application to foreground. **Parameters** \[in] **appid** application id from manifest file #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is already locked [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error [MAC\_ERR\_SERVICE](#a343256ae5f150542a1f6a38fcaca216ca12b59c43d38429cdcaeaa7b45461930c) application is service (no GUI) #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a50). ### sysToForground() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysToForground ### sysUnSetAppid() [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysUnSetAppid This API will unregister your application from MAC. MAC will destroy used GUI region and free all resources. #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success {% hint style="info" %} This API is needed for specific usecase. Not intended for general use. Be sure, to invoke this API before your application exits. {% endhint %} ### sysVirtualKeyboard()\[1/2] [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysVirtualKeyboard Set virtual keyboard mode **Parameters** \[in] **mode** mask using macKeyboard value #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked [MAC\_ERR\_VISIBLE](#a343256ae5f150542a1f6a38fcaca216ca0ed934fa7a34568e74061ef14dfe3958) application is not currently visible {% hint style="info" %} Please see [macKeyboard](#a7ecd7d8b8c98bd60b3a7d95dc5da7c5f) enum for reference. This configuration is stored per application. {% endhint %} ### sysVirtualKeyboard()\[2/2] [MAC\_API](/s-adk-5.1-programmers-guide/readme/files/dir_e65d4d0c0ba9865676ee3897978ecbf1/dir_517ad9dc307a0538d3e19e98627cc0af/dir_619a55c4c313d761d1f6a99da403e1c9/mac_8h.md#a8794217925bb13f504792c2e3669bf4b) \[macError]\(#a343256ae5f150542a1f6a38fcaca216c) vfimac::sysVirtualKeyboard Show/hide virtual keyboard **Parameters** \[in] **mode** keyboard mode from macKeyboard enum #### Returns Returns an [macError](#a343256ae5f150542a1f6a38fcaca216c) value enum [MAC\_ERR\_OK](#a343256ae5f150542a1f6a38fcaca216cae7c1d68ad552537bb450a291714bc71f) success [MAC\_ERR\_IPC](#a343256ae5f150542a1f6a38fcaca216ca2a66718018e9604e11409a6bb0d9ee32) communication error [MAC\_ERR\_LOCKED](#a343256ae5f150542a1f6a38fcaca216ca25189ddd505007eeface48fa0f6336e2) layout is currently locked [MAC\_ERR\_VISIBLE](#a343256ae5f150542a1f6a38fcaca216ca0ed934fa7a34568e74061ef14dfe3958) application is not currently visible {% hint style="info" %} Please see [macKeyboard](#a7ecd7d8b8c98bd60b3a7d95dc5da7c5f) enum for reference. This configuration is stored per application. {% endhint %} #### Examples [mac\_demo1.cpp](/s-adk-5.1-programmers-guide/readme/examples/mac_demo1_8cpp-example.md#a18). --- # 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/modules/group__mac/namespacevfimac.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.