> 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/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfiprt.md). # vfiprt [Data Structures](#nested-classes) | [Typedefs](#typedef-members) | [Enumerations](#enum-members) | [Functions](#func-members) | | | | --------------- | ----------------------------------------------------------------------------------------------------------------------------- | | Data Structures | | | struct | [prtControlSeq](#structvfiprt_1_1prt_control_seq) | | struct | [PrtErrorEntry](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/structvfiprt_1_1_prt_error_entry.md) | | | | | --------------- | --------------------------------------------------------------------- | | Typedefs | | | typedef void(\* | [prtAsyncCallback](#a3691bc12eb8cadf581fb757005ff07c0)) (void \*data) | | | | | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enumerations | | | enum |

PrtError {
PRT\_OK = 0, PRT\_BUSY = -1, PRT\_PAPERJAM = -2, PRT\_HEADOPEN = -3,
PRT\_PAPEREND = -4, PRT\_OVERHEAT = -5, PRT\_OVERVOLTAGE = -6, PRT\_UNDERVOLTAGE = -7,
PRT\_FAIL = -8, PRT\_SCRIPT\_ERROR = -9, PRT\_NO\_PRINTER = -10, PRT\_BATTERY = -11,
PRT\_UNSUPPORTED = -20, PRT\_INVALID\_PARAM = -21, PRT\_NO\_RESOURCE = -22, PRT\_FILE\_NOT\_FOUND = -23,
PRT\_PROTOCOL = -24, PRT\_FINAL\_RESULT =- 40, PRT\_TIMEOUT = -41
}

| | |

List of general errors. More...

| | enum | [PrtMode](#aee9be45580d5cde27d2a82b09fe3c601) { [PRT\_PREFER\_GRAPHICS](#aee9be45580d5cde27d2a82b09fe3c601a2f0f079bd5a47252c0a92a2815571c9e), [PRT\_PREFER\_TEXT](#aee9be45580d5cde27d2a82b09fe3c601aac04ca493dd2c33ce7f7f002512f6adf) } | | enum |

PrtPropertyInt {
PRT\_PROP\_STATE =0, PRT\_PROP\_HEAD\_TEMP, PRT\_PROP\_HEAD\_VOLTAGE, PRT\_PROP\_PIXEL\_WIDTH,
PRT\_PROP\_CONTRAST, PRT\_PROP\_DEFAULT\_FONT\_SIZE, PRT\_PROP\_PRINT\_MODE, PRT\_PROP\_JS\_QUOTA\_SIZE
}

| | |

List of numeric properties. More...

| | enum |

PrtPropertyString {
PRT\_PROP\_RESOURCE\_PATH, PRT\_PROP\_FILE\_PREFIX, PRT\_PROP\_DEFAULT\_FONT, PRT\_PROP\_CSS,
PRT\_PROP\_INIFILE, PRT\_PROP\_JS\_ROOT, PRT\_PROP\_DEVICE, PRT\_PROP\_JS\_QUOTA\_ROOT,
PRT\_PROP\_CP\_APP\_DIR
}

| | |

List of string properties. More...

| | | | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Functions | | | bool | [prtFinalResult](#ab5aada82cb359dbc6a74d478ee7d46df) (int x) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [prtSetPropertyInt](#a4226eb3c80a05a57e1bdcae1d802b7fb) (enum [PrtPropertyInt](#a5616550e7b7e340d3e599ba1aece137e) property, int [value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [prtGetPropertyInt](#a328666bdb869598ae87db05f5376fa5b) (enum [PrtPropertyInt](#a5616550e7b7e340d3e599ba1aece137e) property, int \*[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [prtSetPropertyString](#a019a78a3989581d2412ac274c1cf3401) (enum [PrtPropertyString](#a063ad187f3b6a77eca82feb4065ed489) property, const char \*[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | int | [prtSetPropertyString](#a53397309ce5cc150bb54a289066a082b) (enum [PrtPropertyString](#a063ad187f3b6a77eca82feb4065ed489) property, const std::string &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [prtGetPropertyString](#a5f28969939265c39c352b0e78d0871c0) (enum [PrtPropertyString](#a063ad187f3b6a77eca82feb4065ed489) property, char \*[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), int len) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [prtGetPropertyString](#a6d204c112d27f61000bc6343b2f45a22) (enum [PrtPropertyString](#a063ad187f3b6a77eca82feb4065ed489) property, std::string &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209)) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [prtFormat](#a5d53221623bd3d71eba771b097209ebb) (const char \*format,...) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [prtFormatV](#a7087e0d1c8dbbb4ddb7c96f2906c0edc) (const char \*format, va\_list va) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL](#a31b1c26648a592e4e93cd559e10b7d75) (const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const char \*url, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL](#a810bf85ce9c0f3e1707750267aa7e401) (const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&url, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL](#a38d5bb87f971afe9f7e9a815e5f82d57) (const char \*url, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL](#a345d67f849bbabf6bf4b63d03cc66046) (const std::string \&url, bool landscape=false) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtHTML](#afe19510258113242e1b45a44a81fd27c) (const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtHTML](#ad9eef43e35a159f1bdadf10705e6f9c6) (const std::string \&text, bool landscape=false) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURLAsync](#a8de43d45ffeef13d5c41c2e21bea48e9) (const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const char \*url, bool landscape=false, [prtAsyncCallback](#a3691bc12eb8cadf581fb757005ff07c0) cb=0, void \*cbdata=0) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURLAsync](#a6b468947807758e2e79df38538804708) (const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&url, bool landscape=false, [prtAsyncCallback](#a3691bc12eb8cadf581fb757005ff07c0) cb=0, void \*cbdata=0) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURLAsync](#abc632fae0d62e53379723f35b13dce7f) (const char \*url, bool landscape=false, [prtAsyncCallback](#a3691bc12eb8cadf581fb757005ff07c0) cb=0, void \*cbdata=0) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURLAsync](#a186a4c8cd2f927b80c6a537c617ae92b) (const std::string \&url, bool landscape=false, [prtAsyncCallback](#a3691bc12eb8cadf581fb757005ff07c0) cb=0, void \*cbdata=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtHTMLAsync](#ad52f1a074846b76e2b85c3a495fbe211) (const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text, bool landscape=false, [prtAsyncCallback](#a3691bc12eb8cadf581fb757005ff07c0) cb=0, void \*cbdata=0) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtHTMLAsync](#a41983b7c56c6c991abac955ba15ea1e0) (const std::string \&text, bool landscape=false, [prtAsyncCallback](#a3691bc12eb8cadf581fb757005ff07c0) cb=0, void \*cbdata=0) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtWait](#a83f7a62f65843e99ed9cbb9b9e40f643) (int timeout\_msec=-1) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2PNG](#aaae2a4a5f9812176ccfb58301fa6f53c) (const char \*destfile, int width, const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const char \*url, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2PNG](#a054b7b38b39b0d94422bb68481b704d7) (const std::string \&destfile, int width, const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const char \*url, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2PNG](#a19e23768c6942423b6361ba37adb2511) (const char \*destfile, int width, const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&url, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2PNG](#a330b2630efc51f8d3636b1265cfecd0d) (const std::string \&destfile, int width, const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&url, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2PNG](#acfab62a558524ed8957f67089dc7ab58) (const char \*destfile, int width, const char \*url, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2PNG](#a962dc49cb48b697319d41cbe8c805c30) (const std::string \&destfile, int width, const char \*url, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2PNG](#a9b7f3018f44a8cbec64aa1555faeeb09) (const char \*destfile, int width, const std::string \&url, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2PNG](#a4ec8edf8499b43e8cefa1d0d0ad0d67d) (const std::string \&destfile, int width, const std::string \&url, bool landscape=false) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtHTML2PNG](#a68b5d075c73ff3ae0be5ccce9afc1d33) (const char \*destfile, int width, const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtHTML2PNG](#af4dea83f2276e04f338d949e6f31d183) (const char \*destfile, int width, const std::string \&text, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtHTML2PNG](#a0ecc3a65a8f7b9d6440defaeb6de99fe) (const std::string \&destfile, int width, const std::string \&text, bool landscape=false) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2ColorPNG](#acf30cbb37e339d1ebe62ca90a8822951) (const char \*destfile, int width, const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const char \*url, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2ColorPNG](#a90f17ca1c729b01fd3a7dd47c1420533) (const std::string \&destfile, int width, const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const char \*url, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2ColorPNG](#a1d69bd9429e18e3aa99e998b8059f6fe) (const char \*destfile, int width, const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&url, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2ColorPNG](#a1b9968e73f69b8dcf85828a868fb7d35) (const std::string \&destfile, int width, const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&url, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2ColorPNG](#a0d35889a54a1682202ec7a795e4fcd28) (const char \*destfile, int width, const char \*url, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2ColorPNG](#aa1c8664b1f6cb8b5198589250d184986) (const std::string \&destfile, int width, const char \*url, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2ColorPNG](#a027f7e400ef3aed22ab14ea03df81c38) (const char \*destfile, int width, const std::string \&url, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2ColorPNG](#ad6fd8f2cc4935bb66f3c94348e768055) (const std::string \&destfile, int width, const std::string \&url, bool landscape=false) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtHTML2ColorPNG](#ace7941298deb1c71520d2ccc1f59aae5) (const char \*destfile, int width, const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtHTML2ColorPNG](#a5fa14bf8f1254b4638b750f84076be04) (const char \*destfile, int width, const std::string \&text, bool landscape=false) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtHTML2ColorPNG](#af8a3a20c1778770a4d0acee1ef6786a3) (const std::string \&destfile, int width, const std::string \&text, bool landscape=false) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2Text](#a5fda025e6ba20fdc32feede8915ef8e0) (std::string \&result, int width, const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const char \*url, const [prtControlSeq](#structvfiprt_1_1prt_control_seq) \&ctrl) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2Text](#abd3046756f8ef15af5fb6e88485c0592) (std::string \&result, int width, const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&url, const [prtControlSeq](#structvfiprt_1_1prt_control_seq) \&ctrl) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2Text](#afaeaa2d5e1b72fea20693ec01a02e052) (std::string \&result, int width, const char \*url, const [prtControlSeq](#structvfiprt_1_1prt_control_seq) \&ctrl) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtURL2Text](#a1107e98269b7ae36ee1a3e05bda48f5d) (std::string \&result, int width, const std::string \&url, const [prtControlSeq](#structvfiprt_1_1prt_control_seq) \&ctrl) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtHTML2Text](#a9f3dc390acd8a321e81a3c8a23fcc473) (std::string \&result, int width, const [stringmap](/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfihtml.md#a53240b3eda61c045f82728814874a1f8) &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text, const [prtControlSeq](#structvfiprt_1_1prt_control_seq) \&ctrl) | | enum [PrtError](#aabb64aaac27500bf4b3b419feff87361) | [prtHTML2Text](#ac4b5f41ae3fc56a1fc2b1a78635af6b0) (std::string \&result, int width, const std::string \&text, const [prtControlSeq](#structvfiprt_1_1prt_control_seq) \&ctrl) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [prtGetFD](#a4c7078ea0b88cacda6d6eba511606e81) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [prtSetCatalog](#a7678b42a2b4a33d7b8c53a71ff0c5284) (const std::string \&filename) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void | [prtCatalogSetDelayedRelease](#acc2a03e3c65b5c8c03f9c47d3731b7ef) (unsigned num) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) unsigned | [prtCatalogGetDelayedRelease](#a901e493ccff126fd4e97f9a94a003991) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [prtGetText](#a3f09958fa5e5dfd73947570eede09f3e) (const std::string \&name, const std::string \&deflt="") | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [prtGetHtml](#a894c3adbbd91f7f706ab907314ca541c) (const std::map< std::string, std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text, std::string \&html, bool full) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [prtGetHtml](#a4a2c02b03cb291bdc4ed559ebf7a6f4d) (const std::map< std::string, std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&text, std::string \&html) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [prtGetHtmlURL](#aaea92124361b8c4129b83e65c19a187c) (const std::map< std::string, std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&url, std::string \&html, bool full) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [prtGetHtmlURL](#a2036b8b510f767ef947943996187124e) (const std::map< std::string, std::string > &[value](/adk-5.0-programmers-guide/readme/files/dir_30aba3d9bf6279a25d84abe4015711f7/dir_f7a957c8f5c8e80b5a8d4b37f193d419/dir_e8da2933844aa72825eccee783cf08f3/_web_service_wrappers_8c.md#a6e248376c0290338633d8137822eb209), const std::string \&url, std::string \&html) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int | [prtSetRemotePrinter](#acdfd03af403f906b8ddf8f4faba80efd) (const std::string \&address) | | const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) char \* | [prtLibVersion](#abfc2b04f8ca018750fb58662de716e5e) () | | const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) char \* | [prt\_GetVersion](#aacc02fb690d18054f009b4b18d31b9f0) () | | const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::vector< [PrtErrorEntry](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/structvfiprt_1_1_prt_error_entry.md) > & | [prtErrorList](#a0bf71d84338672c928d2849a74b70349) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string | [prtScriptError](#a2b668474952d2a2c807fd227246f40a0) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void | [prtSetLocalProperties](#ab215cbde888ebfaf9ff0653de6811dd5) (bool local) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) bool | [prtGetLocalProperties](#aaf735eaaf5aee3e3063ad4288b94621c) () | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void | [prtSetLogMask](#afaef426fe1518ee0286774d61d7cb401) (unsigned mask) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) unsigned | [prtGetLogMask](#a7afd32c4c56826b494d22abfcb98164e) (void) | | [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void | [prtAddFontDir](#a75f7f156ae5226185808997e23f28d68) (const char \*dir) | *** ### DataStructure Documentation ### vfiprt::prtControlSeq struct vfiprt::prtControlSeq control sequences that will be used during conversion to text. {% hint style="info" %} These control sequences may contain 0-bytes! {% endhint %} | | | | | ----------- | --------------------- | ------------------------------------------------------------------------------------------------- | | Data Fields | | | | string | boldOff | deactivate bold printing | | string | boldOn | activate bold printing | | string | fontDoubleHeight | switch to double height font (activated with font-size:32, see HTMLPrinter users guide) | | string | fontDoubleWidth | switch to double width font (activated with font-size:40, see HTMLPrinter users guide) | | string | fontDoubleWidthHeight | switch to double width and height font (activated with font-size:48, see HTMLPrinter users guide) | | string | fontNormal | switch to normal (default) font (activated with font-size:24, see HTMLPrinter users guide) | | string | italicOff | deactivate italic printing | | string | italicOn | activate italic printing | | string | underlineOff | deactivate underline printing | | string | underlineOn | activate underline printing | ### TypedefDocumentation ### prtAsyncCallback typedef void(\\\* prtAsyncCallback) (void \\\*data) callback function that is called when printing has finished **Parameters** \[in] **data** data pointer provided by the application {% hint style="info" %} The callback will be run within a different thread context! {% endhint %} ### EnumerationType Documentation ### PrtError enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) List of general errors. | | | | --------------------- | ------------------------------------------------------------------------------------------------------------- | | Enumerator | | | PRT\_OK | no error | | PRT\_BUSY | Printing in progress | | PRT\_PAPERJAM | Paper jam | | PRT\_HEADOPEN | Head open | | PRT\_PAPEREND | Paper end | | PRT\_OVERHEAT | Head too hot | | PRT\_OVERVOLTAGE | Head over voltage | | PRT\_UNDERVOLTAGE | Head under voltage | | PRT\_FAIL | function failed (generic error) | | PRT\_SCRIPT\_ERROR | error during script processing, check [prtScriptError()](#a2b668474952d2a2c807fd227246f40a0) for more details | | PRT\_NO\_PRINTER | no printer available or file cannot be created in case of printing to a file | | PRT\_BATTERY | battery error (e.g. temperature) | | PRT\_UNSUPPORTED | function not supported on used hardware | | PRT\_INVALID\_PARAM | invalid parameters passed, e.g. NULL pointer for mandatory parameter | | PRT\_NO\_RESOURCE | resource could not be allocated | | PRT\_FILE\_NOT\_FOUND | file not found | | PRT\_PROTOCOL | protocol error when talking to the print service | | PRT\_FINAL\_RESULT | will never be returned, just used for determining if a result is a final result | | PRT\_TIMEOUT | timeout in [prtWait()](#a83f7a62f65843e99ed9cbb9b9e40f643) | ### PrtMode enum \[PrtMode]\(#aee9be45580d5cde27d2a82b09fe3c601) | | | | --------------------- | - | | Enumerator | | | PRT\_PREFER\_GRAPHICS | | | PRT\_PREFER\_TEXT | | ### PrtPropertyInt enum \[PrtPropertyInt]\(#a5616550e7b7e340d3e599ba1aece137e) List of numeric properties. | | | | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Enumerator | | | PRT\_PROP\_STATE | printer state (just using the subset of PrtError that reflects the state (read only) | | PRT\_PROP\_HEAD\_TEMP |

Head temperature value in degrees Celsius (read only)

Note V/OS does not support reading the head temperature

| | PRT\_PROP\_HEAD\_VOLTAGE | Head voltage value in mV (read only) | | PRT\_PROP\_PIXEL\_WIDTH | printer width in pixels, this may be 0 if the printer is temporarily not available. (read only) | | PRT\_PROP\_CONTRAST |

printer contrast 0...255

Note Setting the contrast will only show some effect if the underlying system supports it.

| | PRT\_PROP\_DEFAULT\_FONT\_SIZE |

Default font size

| | PRT\_PROP\_PRINT\_MODE | Preferred print mode: PRT\_PREFER\_GRAPHICS (default) or PRT\_PREFER\_TEXT, ignored if not supported by the printer | | PRT\_PROP\_JS\_QUOTA\_SIZE |

If >0 filesystem quota in kilobytes for use by JavaScript, see also PRT\_PROP\_JS\_QUOTA\_ROOT

| ### PrtPropertyString enum \[PrtPropertyString]\(#a063ad187f3b6a77eca82feb4065ed489) List of string properties. | | | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Enumerator | | | PRT\_PROP\_RESOURCE\_PATH | Resource path, default is resource/print | | PRT\_PROP\_FILE\_PREFIX | prefix that is added in front of the URL in uiInvokeURL and to the template names, e.g. using "en/" would access the files in the subdirectory "en". | | PRT\_PROP\_DEFAULT\_FONT |

Default font name

| | PRT\_PROP\_CSS | name of a CSS file | | PRT\_PROP\_INIFILE | name of the INI file, setting this property has the effect of reading and evaluating that file, i.e. the default font, font size and the CSS file name are updated | | PRT\_PROP\_JS\_ROOT | Setting this path activates the JavaScript filesystem module. I/O is restricted to happen inside this path. Use "$APPDIR" to refer to this path from within JavaScript. Images and videos may also use "$APPDIR" to refer to files in this path. | | PRT\_PROP\_DEVICE | If not empty, printer device to be used on server side, e.g. /dev/ttyAMA0, not supported on all platforms, only devices that are accessibly by the printer server can be used | | PRT\_PROP\_JS\_QUOTA\_ROOT | If not empty base directory for quota JavaScript calculation, default is "", see also [PRT\_PROP\_JS\_QUOTA\_SIZE](#a5616550e7b7e340d3e599ba1aece137ead9e51751423f88f62d12e2ca667952cf) | | PRT\_PROP\_CP\_APP\_DIR | CP app directory, if set only receipts from the app dir can be printed. It should point to the base app directory without platform, e.g. /home/sys14/www/\ on V/OS | ### FunctionDocumentation ### prt\_GetVersion() const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) char\\\* vfiprt::prt\_GetVersion returns a zero-terminated string with version and build information of libvfiguiprt in ADK version string format: \.\.\-\, e.g. "1.2.3-4" #### Returns version string ### prtAddFontDir() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void vfiprt::prtAddFontDir Add directory to printer font search path **Parameters** \[in] **dir** directory to add {% hint style="info" %} For security reasons this function is only available if the printer server runs in the context of the application (e.g. when using embedded ARRS) but it is not provided when running the printer server as separate process. {% endhint %} ### prtCatalogGetDelayedRelease() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) unsigned vfiprt::prtCatalogGetDelayedRelease Get the maximum number of unused catalogs that are kept in memory. #### Returns number of catalogs {% hint style="info" %} Catalog storage is shared with the GUI module, i.e. this setting may be changed by calls to [uiCatalogSetDelayedRelease()](/adk-5.0-programmers-guide/readme/modules/group__vfigui/namespacevfigui.md#aac69533e0d547c76b34253f4458c525c) {% endhint %} ### prtCatalogSetDelayedRelease() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void vfiprt::prtCatalogSetDelayedRelease Set the maximum number of catalogs that are kept in memory although being unused. This improves load time when a catalog is used again, since when still in memory it does not need to be read from disk (default: 0) **Parameters** \[in] **num** number of catalogs {% hint style="info" %} Catalog storage is shared with the GUI module, i.e. this setting may be changed by calls to [uiCatalogSetDelayedRelease()](/adk-5.0-programmers-guide/readme/modules/group__vfigui/namespacevfigui.md#aac69533e0d547c76b34253f4458c525c) {% endhint %} ### prtErrorList() const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::vector\\<[PrtErrorEntry](https://github.com/verifoneone/verifone-git-book-adk/tree/ADK5.0_staging/structvfiprt_1_1_prt_error_entry.md)\\>& vfiprt::prtErrorList obtain list of non-fatal errors that happened last while printing a receipt. #### Returns reference to the error list of the last receipt printed in this thread. ### prtFinalResult() bool vfiprt::prtFinalResult inline ### prtFormat() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfiprt::prtFormat perform printf-like formatting. **Parameters** \[in] **format** printf-like format string. It supports the commonly known format specifiers 's', 'i', 'd', 'u', 'o', 'x', 'X', 'p', 'c', 'f', 'e', 'g'. In addition the following format specifiers are supported:'S': format as string and substitute the special HTML characters '&', '<', '>', '"' and ''' by character references (e.g. '&', '<' ...).'C': format as character and sustitute HTML characters #### Returns formatted string ### prtFormatV() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfiprt::prtFormatV perfom printf-like formatting. This is the same as [prtFormat()](#a5d53221623bd3d71eba771b097209ebb) just taking a va\_list instead of a variable number of arguments ### prtGetFD() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfiprt::prtGetFD obtain internal file descriptor for use in poll(). This may be used to check whether the result has been received from the print service. #### Returns file descriptor or -1 in case no printing is active ### prtGetHtml()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfiprt::prtGetHtml ### prtGetHtml()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfiprt::prtGetHtml preprocess HTML code and return the resulting string **Parameters** \[in] **value** values used for insertions \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). \[out] **html** resulting HTML code \[in] **full** optional parameter: If false or missing just substitute the XML processing instructions, if true in addition use inline images, insert CSS code and return full HTML document #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) ### prtGetHtmlURL()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfiprt::prtGetHtmlURL ### prtGetHtmlURL()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfiprt::prtGetHtmlURL preprocess HTML code and return the resulting string **Parameters** \[in] **value** values used for insertions \[in] **url** location of the dialog file. The location is prefixed by the resource path and by the optional prefix (see also UI\_PROP\_RESOURCE\_PATH, UI\_PROP\_FILE\_PREFIX) unless an absolute path was provided. \[out] **html** resulting HTML code \[in] **full** optional parameter: If false or missing just substitute the XML processing instructions, if true in addition use inline images, insert CSS code and return full HTML document #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) ### prtGetLocalProperties() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) bool vfiprt::prtGetLocalProperties #### Returns true if thread local properties are used, else return false ### prtGetLogMask() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) unsigned vfiprt::prtGetLogMask Get log mask #### Returns current log mask ### prtGetPropertyInt() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfiprt::prtGetPropertyInt get int property **Parameters** \[in] **property** property to be set \[out] **value** current value #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) ### prtGetPropertyString()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfiprt::prtGetPropertyString get string property **Parameters** \[in] **property** property to be set \[out] **value** current value \[in] **len** size ouf output buffer value in bytes #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) ### prtGetPropertyString()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfiprt::prtGetPropertyString get string property **Parameters** \[in] **property** property to be set \[out] **value** current value #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) ### prtGetText() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfiprt::prtGetText lookup a text from current loaded catalog by *key* name. If text is not found in catalog or no catalog is loaded the function returns value in in parameter *default*. **Parameters** \[in] **name** of key used to lookup the text in calalog \[in] **deflt** text that is returned, if text is not found in calalog #### Returns text from catalog for success, else value in parameter *default* ### prtHTML()\[1/2] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtHTML inline the same as [prtHTML()](#afe19510258113242e1b45a44a81fd27c) just using an empty value map ### prtHTML()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtHTML print an HTML document (synchronous) **Parameters** \[in] **value** name value pairs that are used as for variable substitutions. \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). \[in] **landscape** activate landscape printing #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) ### prtHTML2ColorPNG()\[1/3] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtHTML2ColorPNG inline the same as [prtHTML2ColorPNG()](#ace7941298deb1c71520d2ccc1f59aae5) just using an empty value map ### prtHTML2ColorPNG()\[2/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtHTML2ColorPNG render an HTML file to a color PNG image **Parameters** \[in] **destfile** name of the destination PNG file \[in] **width** width of the image in pixels (height if landscape==true) \[in] **value** name value pairs that are used as for variable substitutions. \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). \[in] **landscape** activate landscape printing (image is rotated by 90 degrees) #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) ### prtHTML2ColorPNG()\[3/3] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtHTML2ColorPNG inline Overloaded function: Just using std::string for destfile ### prtHTML2PNG()\[1/3] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtHTML2PNG inline the same as [prtHTML2PNG()](#a68b5d075c73ff3ae0be5ccce9afc1d33) just using an empty value map ### prtHTML2PNG()\[2/3] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtHTML2PNG render an HTML file to a PNG image **Parameters** \[in] **destfile** name of the destination PNG file \[in] **width** width of the image in pixels (height if landscape==true) \[in] **value** name value pairs that are used as for variable substitutions. \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). \[in] **landscape** activate landscape printing (image is rotated by 90 degrees) #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) ### prtHTML2PNG()\[3/3] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtHTML2PNG inline Overloaded function: Just using std::string for destfile ### prtHTML2Text()\[1/2] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtHTML2Text inline short cut with empty value map ### prtHTML2Text()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtHTML2Text convert HTML document to text string. Custom control sequences can be passed that are inserted when switching the font size or style **Parameters** \[out] **result** resulting text string \[in] **width** width of the image in printable characters \[in] **value** name value pairs that are used as for variable substitutions. \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). \[in] **ctrl** control sequences #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) ### prtHTMLAsync()\[1/2] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtHTMLAsync inline the same as [prtHTMLAsync()](#ad52f1a074846b76e2b85c3a495fbe211) just using an empty value map ### prtHTMLAsync()\[2/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtHTMLAsync asynchronously start printing an HTML document, the result has to be obtained using [prtWait()](#a83f7a62f65843e99ed9cbb9b9e40f643). **Parameters** \[in] **value** name value pairs that are used as for variable substitutions. \[in] **text** string containing an HTML fragment (i.e. the part between \ and \). \[in] **landscape** activate landscape printing \[in] **cb** optional callback function that is called when printing has finished \[in] **cbdata** data pointer that is passed on to the callback function #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) {% hint style="info" %} If [prtWait()](#a83f7a62f65843e99ed9cbb9b9e40f643) is not called the next call to [prtURLAsync()](#a8de43d45ffeef13d5c41c2e21bea48e9) or [prtHTMLAsync()](#ad52f1a074846b76e2b85c3a495fbe211) will return PRT\_BUSY. {% endhint %} ### prtLibVersion() const [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) char\\\* vfiprt::prtLibVersion read library version #### Returns version string ### prtScriptError() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfiprt::prtScriptError #### Returns string containing information about errors that were reported during last script processing ### prtSetCatalog() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfiprt::prtSetCatalog load and set a catalog file containing name-value text pairs to be inserted with HTML placeholder \. The current catalog is unloaded with filename=="" or by loading another catalog file. **Parameters** \[in] **filename** of the catalog, empty string to unload the current dialog #### Returns PRT\_OK if file was successfully loaded, else error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) ### prtSetLocalProperties() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void vfiprt::prtSetLocalProperties de-/activate thread local properties for the current thread. Activating thread local properties initially copies the global properties to the current thread. **Parameters** \[in] **local** if true activate thread local properties, if false discard them ### prtSetLogMask() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) void vfiprt::prtSetLogMask Set log mask **Parameters** \[in] **mask** logging mask (see PRT\_LOGMASK) ### prtSetPropertyInt() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfiprt::prtSetPropertyInt set int property **Parameters** \[in] **property** property to be set \[in] **value** new value #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) {% hint style="info" %} Properties are specific to each thread {% endhint %} ### prtSetPropertyString()\[1/2] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfiprt::prtSetPropertyString set string property **Parameters** \[in] **property** property to be set \[in] **value** new value #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) {% hint style="info" %} Properties are specific to each thread {% endhint %} ### prtSetPropertyString()\[2/2] int vfiprt::prtSetPropertyString inline Overloaded function: Just using std::string for value ### prtSetRemotePrinter() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int vfiprt::prtSetRemotePrinter set remote printer address **Parameters** \[in] **address** printer address. This value overwrites the address set using the LPD environment variable. This may be used to set an IP address and port (e.g. ':0' would use the internal default printer). Using an empty string will revert to the default setting. #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)). ### prtURL()\[1/4] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL inline the same as [prtURL()](#a31b1c26648a592e4e93cd559e10b7d75) just using an empty value map ### prtURL()\[2/4] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL inline Overloaded function: Just using std::string for url ### prtURL()\[3/4] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL print an HTML file (synchronous) **Parameters** \[in] **value** name value pairs that are used as for variable substitutions. \[in] **url** location of the HTML file. The location is prefixed by the resource path and by the optional prefix (see also PRT\_PROP\_RESOURCE\_PATH, PRT\_PROP\_FILE\_PREFIX) \[in] **landscape** activate landscape printing #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) ### prtURL()\[4/4] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL inline Overloaded function: Just using std::string for url ### prtURL2ColorPNG()\[1/8] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2ColorPNG inline shortcut omitting value ### prtURL2ColorPNG()\[2/8] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2ColorPNG inline Overloaded function: Just using std::string for url ### prtURL2ColorPNG()\[3/8] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2ColorPNG render an HTML file to a color PNG image **Parameters** \[in] **destfile** name of the destination PNG file \[in] **width** width of the image in pixels (height if landscape==true) \[in] **value** name value pairs that are used as for variable substitutions. \[in] **url** location of the HTML file. The location is prefixed by the resource path and by the optional prefix (see also PRT\_PROP\_RESOURCE\_PATH, PRT\_PROP\_FILE\_PREFIX) \[in] **landscape** activate landscape printing (image is rotated by 90 degrees) #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) ### prtURL2ColorPNG()\[4/8] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2ColorPNG inline Overloaded function: Just using std::string for url ### prtURL2ColorPNG()\[5/8] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2ColorPNG inline Overloaded function: Just using std::string for destfile ### prtURL2ColorPNG()\[6/8] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2ColorPNG inline Overloaded function: Just using std::string for destfile and url ### prtURL2ColorPNG()\[7/8] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2ColorPNG inline Overloaded function: Just using std::string for destfile ### prtURL2ColorPNG()\[8/8] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2ColorPNG inline Overloaded function: Just using std::string for destfile and url ### prtURL2PNG()\[1/8] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2PNG inline shortcut omitting value ### prtURL2PNG()\[2/8] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2PNG inline Overloaded function: Just using std::string for url ### prtURL2PNG()\[3/8] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2PNG render an HTML file to a black and white PNG image **Parameters** \[in] **destfile** name of the destination PNG file \[in] **width** width of the image in pixels (height if landscape==true) \[in] **value** name value pairs that are used as for variable substitutions. \[in] **url** location of the HTML file. The location is prefixed by the resource path and by the optional prefix (see also PRT\_PROP\_RESOURCE\_PATH, PRT\_PROP\_FILE\_PREFIX) \[in] **landscape** activate landscape printing (image is rotated by 90 degrees) #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) ### prtURL2PNG()\[4/8] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2PNG inline Overloaded function: Just using std::string for url ### prtURL2PNG()\[5/8] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2PNG inline Overloaded function: Just using std::string for destfile ### prtURL2PNG()\[6/8] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2PNG inline Overloaded function: Just using std::string for destfile and url ### prtURL2PNG()\[7/8] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2PNG inline Overloaded function: Just using std::string for destfile ### prtURL2PNG()\[8/8] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2PNG inline Overloaded function: Just using std::string for destfile and url ### prtURL2Text()\[1/4] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2Text inline short cut with empty value map ### prtURL2Text()\[2/4] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2Text inline Overloaded function: Just using std::string for url ### prtURL2Text()\[3/4] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2Text convert HTML document to text string. Custom control sequences can be passed that are inserted when switching the font size or style **Parameters** \[out] **result** resulting text string \[in] **width** width of the image in printable characters \[in] **value** name value pairs that are used as for variable substitutions. \[in] **url** location of the HTML file. The location is prefixed by the resource path and by the optional prefix (see also PRT\_PROP\_RESOURCE\_PATH, PRT\_PROP\_FILE\_PREFIX) \[in] **ctrl** control sequences #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) ### prtURL2Text()\[4/4] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURL2Text inline Overloaded function: Just using std::string for url ### prtURLAsync()\[1/4] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURLAsync inline the same as [prtURLAsync()](#a8de43d45ffeef13d5c41c2e21bea48e9) just using an empty value map ### prtURLAsync()\[2/4] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURLAsync inline Overloaded function: Just using std::string for url ### prtURLAsync()\[3/4] [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURLAsync asynchronously start printing an HTML file, the result has to be obtained using [prtWait()](#a83f7a62f65843e99ed9cbb9b9e40f643). **Parameters** \[in] **value** name value pairs that are used as for variable substitutions. \[in] **url** location of the HTML file. The location is prefixed by the resource path and by the optional prefix (see also PRT\_PROP\_RESOURCE\_PATH, PRT\_PROP\_FILE\_PREFIX) \[in] **landscape** activate landscape printing \[in] **cb** optional callback function that is called when printing has finished \[in] **cbdata** data pointer that is passed on to the callback function #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) {% hint style="info" %} If [prtWait()](#a83f7a62f65843e99ed9cbb9b9e40f643) is not called the next call to [prtURLAsync()](#a8de43d45ffeef13d5c41c2e21bea48e9) or [prtHTMLAsync()](#ad52f1a074846b76e2b85c3a495fbe211) will return PRT\_BUSY. {% endhint %} ### prtURLAsync()\[4/4] enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtURLAsync inline Overloaded function: Just using std::string for url ### prtWait() [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) enum \[PrtError]\(#aabb64aaac27500bf4b3b419feff87361) vfiprt::prtWait wait for the printing to finish and return the error code **Parameters** \[in] **timeout\_msec** timeout in milliseconds, a negative value means infinite timeout #### Returns error code (see [PrtError](#aabb64aaac27500bf4b3b419feff87361)) or PRT\_TIMEOUT in case the printing did not finish within the specified timeout. {% hint style="info" %} In case of timeout [prtWait()](#a83f7a62f65843e99ed9cbb9b9e40f643) has to be called again. {% endhint %} --- # 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/adk-5.0-programmers-guide/readme/modules/group__vfiprt/namespacevfiprt.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.