> 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/namespaces/namespacevfifps.md).

# vfifps

[Typedefs](#typedef-members) | [Enumerations](#enum-members) | [Functions](#func-members)

|                 |                                                                                                                                                                                                                                                                                                                                                 |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Typedefs        |                                                                                                                                                                                                                                                                                                                                                 |
| typedef void(\* | [resultCallbackType](#a1533c279c5718316ff33db1874a98c2e)) (void \*dataptr, [FPS\_CB\_Type](#a5d7a8d9c16c82913bda07e2105783e0b) msgType, int width, std::vector< unsigned char > [rawData](/adk-5.0-programmers-guide/readme/files/dir_44d926a17fc606d3c25449ba60427c63/dir_048f823fee1bfb22502a8732b9a001aa/titusstubs_8cpp.md#structraw_data)) |

|              |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Enumerations |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| enum         | [FPS\_RES\_Type](#a3c1df956eda8f33eb06d11d024147870) { [FPS\_RES\_SUCCESS](#a3c1df956eda8f33eb06d11d024147870ad734b6d4c08ca860ae63c788ad44596f) = 0, [FPS\_RES\_FAILURE](#a3c1df956eda8f33eb06d11d024147870a00a8574f25755783ed93b0ac179e9668) = -1, [FPS\_RES\_NO\_PROP](#a3c1df956eda8f33eb06d11d024147870ac442a125e0942b5a31c934464c026a0a) = -2, [FPS\_RES\_INFO\_NOT\_READ](#a3c1df956eda8f33eb06d11d024147870a27ad11a3e1003b122e4e2cb3c22a3d7c) = -3 }                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| enum         | <p><a href="#a5d7a8d9c16c82913bda07e2105783e0b">FPS\_CB\_Type</a> {<br>  <a href="#a5d7a8d9c16c82913bda07e2105783e0ba84fe43ea9b96ff3045a0eba99fe8954e">FPS\_CB\_DATA</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0bad5b77e1822475ee4e0613f3ace7b97cf">FPS\_CB\_ERROR</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0baa6f84cab351ca2d17e25680e866afb74">FPS\_CB\_INFO\_BACKWARD\_MOVEMENT</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0bae19c543080e3618fa126508090986da6">FPS\_CB\_INFO\_BAD\_QUALITY</a>,<br>  <a href="#a5d7a8d9c16c82913bda07e2105783e0ba7db7066974c9ab1cec3f37de1f0a4932">FPS\_CB\_INFO\_CALIB\_START</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba305dee8a6d3d4533be1beb7f5250d37f">FPS\_CB\_INFO\_CENTER\_AND\_PRESS\_HARDER</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba92ebad09a3cb0487835673453ffe5209">FPS\_CB\_INFO\_CLEAN\_SENSOR</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba60dc0416ab3e73510defa8119da9389b">FPS\_CB\_INFO\_CONSOLIDATION\_FAIL</a>,<br>  <a href="#a5d7a8d9c16c82913bda07e2105783e0baffb3a61ba0e2091c6736e64d893608cf">FPS\_CB\_INFO\_CONSOLIDATION\_SUCCEED</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0baf177d44ec60da2c5c4dbdd83f8ca6cee">FPS\_CB\_INFO\_ENROLL\_START</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0baa9dc6d82477af8cc9c4999ef0a9d0640">FPS\_CB\_INFO\_ENROLL\_PROGRESS</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0bab6148b4eae7488dbe57278db50158687">FPS\_CB\_INFO\_FINGER\_DETECT\_START</a>,<br>  <a href="#a5d7a8d9c16c82913bda07e2105783e0bab8b190de5f68ab4ed1e9e9849481b2bc">FPS\_CB\_INFO\_FINGERLEFT</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba6b4af8e322a7d5c9cb5da4b56e7b4be1">FPS\_CB\_INFO\_FINGERRIGHT</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0baa7a904becc2adad54a976e6064ce144b">FPS\_CB\_INFO\_FINGERTOP</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba443f3d7e979ef9ca410cd84569d6b2dc">FPS\_CB\_INFO\_FINGERBOTTOM</a>,<br>  <a href="#a5d7a8d9c16c82913bda07e2105783e0ba832d40195f58cfa3d935970735116ce4">FPS\_CB\_INFO\_GOOD\_IMAGE</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba306f34d4e771bdeffdb6cf71b3f7d8a6">FPS\_CB\_INFO\_GUI\_FINISH</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba144fdeb4fbb2e80a2a588df545b18b38">FPS\_CB\_INFO\_GUI\_FINISH\_DETECT\_START</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba34b79957cb55a81efe2847afca48ae29">FPS\_CB\_INFO\_GUI\_FINISH\_FAIL</a>,<br>  <a href="#a5d7a8d9c16c82913bda07e2105783e0bac3e41f171cd72c71064f3015012e8769">FPS\_CB\_INFO\_GUI\_FINISH\_SUCCEED</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba96e135543aa06812326ff9ca38bdd345">FPS\_CB\_INFO\_IMAGE\_PROCESSED</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba1ba642b17ea14f9320dcabb7a3db8d92">FPS\_CB\_INFO\_JOINT\_DETECTED</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0baeb18217ac28f5d6656642a8098035084">FPS\_CB\_INFO\_KEEP\_FINGER</a>,<br>  <a href="#a5d7a8d9c16c82913bda07e2105783e0ba055cfc2dd7a73a740e6fb73c060ad94c">FPS\_CB\_INFO\_NO\_FINGER</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba42519f5be19064f77e65e239e1b36144">FPS\_CB\_INFO\_PROCESSING\_IMAGE</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba1886e93031810f14479b1faa77df8e2e">FPS\_CB\_INFO\_PUT\_FINGER</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba62b4dbaab0c5cd40b64c94073e0f87c2">FPS\_CB\_INFO\_PUT\_FINGER2</a>,<br>  <a href="#a5d7a8d9c16c82913bda07e2105783e0baa47a6648946ad8dffc21eed18bb7db83">FPS\_CB\_INFO\_PUT\_FINGER3</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba388f341d89a5237ffe71738b212284f1">FPS\_CB\_INFO\_PUT\_FINGER4</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba29f94b2001c06a9bd993f42697184623">FPS\_CB\_INFO\_PUT\_FINGER5</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba08a08925cfa56c984392fe5f0f08f25d">FPS\_CB\_INFO\_REMOVE\_FINGER</a>,<br>  <a href="#a5d7a8d9c16c82913bda07e2105783e0ba01a4bfc51d4f59e597c70a7a5ba06fea">FPS\_CB\_INFO\_START</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0bafad5c808443372f146079e4134a6fab2">FPS\_CB\_INFO\_SWIPE\_IN\_PROGRESS</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba4f0f256adfff299b59d31bb3bd37e063">FPS\_CB\_INFO\_TOO\_DARK</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba7b8ec4d80640e9e7d01a20b6474f36bf">FPS\_CB\_INFO\_TOO\_DRY</a>,<br>  <a href="#a5d7a8d9c16c82913bda07e2105783e0ba7f5db237cc9ebd5a4fcc2da14a6ac5b2">FPS\_CB\_INFO\_TOO\_FAST</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba6402d3434046a7825e98886d19745da9">FPS\_CB\_INFO\_TOO\_HIGH</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba2e7decb9b5a4eb02d0e62198a676d3c5">FPS\_CB\_INFO\_TOO\_LEFT</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba095b21b5793b83493f65d330380024df">FPS\_CB\_INFO\_TOO\_LIGHT</a>,<br>  <a href="#a5d7a8d9c16c82913bda07e2105783e0ba04eb7784eef19503b5d156cdbc8d0e00">FPS\_CB\_INFO\_TOO\_LOW</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba1b2a61e080f36309dcb038c668be67b2">FPS\_CB\_INFO\_TOO\_RIGHT</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0bafebb3b97ae2a1afa00a7058abfa821ad">FPS\_CB\_INFO\_TOO\_SHORT</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba9022096640a0819b342fbb27e14ddb15">FPS\_CB\_INFO\_TOO\_SKEWED</a>,<br>  <a href="#a5d7a8d9c16c82913bda07e2105783e0ba7ae49728abdb2a0f5b81855a51dd2f60">FPS\_CB\_INFO\_TOO\_SMALL</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba71389ab703cd25bf1c1699560646a27b">FPS\_CB\_INFO\_TOO\_STRANGE</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0bacbd17103c399e23a497a9dc95fc416a2">FPS\_CB\_INFO\_TOUCH\_SENSOR</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0ba3dd8259f433b7a4345e6ea365b8431d1">FPS\_CB\_INFO\_VERIFY\_START</a>,<br>  <a href="#a5d7a8d9c16c82913bda07e2105783e0bacaac8be8010f044f993111acfad8ba0a">FPS\_CB\_PICTURE</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0bac6d12b2fe8224338b1acbb6ca669ac99">FPS\_CB\_ANSI\_DATA</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0bac1b8153e221d565bbb0639dc0e160973">FPS\_CB\_ISO\_DATA</a>, <a href="#a5d7a8d9c16c82913bda07e2105783e0baf4a7f345ea2cb22d3496c61862a8128c">FPS\_CB\_PGM\_DATA</a><br>}</p> |
| enum         | <p><a href="#af96966f9c2d007371a573af52137396c">FPS\_PROP\_INT\_Type</a> {<br>  <a href="#af96966f9c2d007371a573af52137396ca5fd73ed7b64a99066d18234779cc768e">FPS\_PROP\_INT\_VERSION</a>, <a href="#af96966f9c2d007371a573af52137396ca7d380debdfe5fd6d07a492363de957f3">FPS\_PROP\_INT\_INFO</a>, <a href="#af96966f9c2d007371a573af52137396ca7dcfb5a4692a1f838f1a89bd79da4eff">FPS\_PROP\_INT\_MINNEXTVERSION</a>, <a href="#af96966f9c2d007371a573af52137396ca19be2ba5702c8157c50567ab9565a901">FPS\_PROP\_INT\_VARIANT</a>,<br>  <a href="#af96966f9c2d007371a573af52137396cae51635291ffea7eb485f94392d7d2b6b">FPS\_PROP\_INT\_FUNCTIONALITY</a>, <a href="#af96966f9c2d007371a573af52137396cabd884e03da5adb4ede39293ccb3f3c02">FPS\_PROP\_INT\_CONFIG</a>, <a href="#af96966f9c2d007371a573af52137396ca1ea544508442573db51171bcf8bad16f">FPS\_PROP\_INT\_ID</a>, <a href="#af96966f9c2d007371a573af52137396cae46d9d075469e89e20d99dc785f034a1">FPS\_PROP\_INT\_AUTHENTIFYID</a>,<br>  <a href="#af96966f9c2d007371a573af52137396cae101c15c4764203b64e60928d36f56d9">FPS\_PROP\_INT\_USAGE</a>, <a href="#af96966f9c2d007371a573af52137396caf8c0384fbf2ab3078ce5ee61453b611e">FPS\_PROP\_INT\_SENSORTYPE</a>, <a href="#af96966f9c2d007371a573af52137396ca6d032055886e50141810e73e0b4af413">FPS\_PROP\_INT\_IMAGEWIDTH</a>, <a href="#af96966f9c2d007371a573af52137396ca0a1ee2e1ed860474a5e4dd930918262a">FPS\_PROP\_INT\_IMAGEHEIGHT</a>,<br>  <a href="#af96966f9c2d007371a573af52137396cae6db6adef8b3771d27a4e72ccb79edab">FPS\_PROP\_INT\_MAXGRABWINDOW</a>, <a href="#af96966f9c2d007371a573af52137396ca4786bbb0e08669892b8e270e2528d9a3">FPS\_PROP\_INT\_COMPANIONVENDORCODE</a>, <a href="#af96966f9c2d007371a573af52137396ca4a2a698dbb7e42a1ac6c8a324d125ec3">FPS\_PROP\_INT\_VERSIONEXT</a>, <a href="#af96966f9c2d007371a573af52137396ca5f8512e22d638abe46541245bdf52532">FPS\_PROP\_INT\_SYSTEMID</a>,<br>  <a href="#af96966f9c2d007371a573af52137396cace5aaae29cb8194bc70ac87d1fa3c90b">FPS\_PROP\_INT\_DATATYPE</a>, <a href="#af96966f9c2d007371a573af52137396ca6709f98fbd780c2cfe1439ccbbb848ae">FPS\_PROP\_INT\_IMAGE\_QUALITY\_LAST</a>, <a href="#af96966f9c2d007371a573af52137396cacb7e2d9e5580b07273a1246c693216a5">FPS\_PROP\_INT\_IMAGE\_NUMBER\_OF\_MINUTIAE\_LAST</a>, <a href="#af96966f9c2d007371a573af52137396ca0a0cbaeeed2746d81f2aa231342c06fb">FPS\_PROP\_INT\_IMAGE\_SIZE</a><br>}</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| enum         | <p><a href="#a94a6e9df02d10dc416e0a1e1b0b6dde7">FPS\_PROP\_STRING\_Type</a> {<br>  <a href="#a94a6e9df02d10dc416e0a1e1b0b6dde7af3d5f46fa532530f27ddc4141dde5cc7">FPS\_PROP\_STRING\_EXTINFO</a>, <a href="#a94a6e9df02d10dc416e0a1e1b0b6dde7a367c168de784483d15f092018f8a2040">FPS\_PROP\_STRING\_INFO</a>, <a href="#a94a6e9df02d10dc416e0a1e1b0b6dde7a5ca8e04652708c1e25a1f0248f2b83ba">FPS\_PROP\_STRING\_TYPE</a>, <a href="#a94a6e9df02d10dc416e0a1e1b0b6dde7ae257bab40a9052975daaa20e49082cb0">FPS\_PROP\_STRING\_HWINFO</a>,<br>  <a href="#a94a6e9df02d10dc416e0a1e1b0b6dde7a0da07d6f8c852bc533ee3f07a6a46c36">FPS\_PROP\_STRING\_GUID</a>, <a href="#a94a6e9df02d10dc416e0a1e1b0b6dde7ac19d3ef4cfa3a54e697a6116272e7fac">FPS\_PROP\_STRING\_SYSTEMNAME</a><br>}</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| enum         | <p><a href="#af3c1346c7455895cfa8c46ccffdf7d50">FPS\_IMG\_Type</a> {<br>  <a href="#af3c1346c7455895cfa8c46ccffdf7d50a44530167bb477ee327f9d91adf0ed966">FPS\_IMG\_RAW</a>, <a href="#af3c1346c7455895cfa8c46ccffdf7d50a4cf384925525f63f40a2521b231f2645">FPS\_IMG\_PGM</a>, <a href="#af3c1346c7455895cfa8c46ccffdf7d50ad37530d8fe77c215c24a0b2702fc7668">FPS\_IMG\_ANSI</a>, <a href="#af3c1346c7455895cfa8c46ccffdf7d50acb8696040ddc981bf83962f59b56f6fb">FPS\_IMG\_ISO</a>,<br>  <a href="#af3c1346c7455895cfa8c46ccffdf7d50ac940fbcfe83c44ee2c9c92f90ec0d460">FPS\_IMG\_ALL</a><br>}</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |

|                                                                                                                                                                                                                                                                      |                                                                                                                                                                            |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Functions                                                                                                                                                                                                                                                            |                                                                                                                                                                            |
| [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int16\_t                                             | [fps\_open](#a0e210dd7087b2ce621faa8ede70b52fc) (std::string \&device)                                                                                                     |
| [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) [FPS\_RES\_Type](#a3c1df956eda8f33eb06d11d024147870) | [fps\_close](#a1bcf940c8fae055399fa4bbca5706857) (int16\_t handle)                                                                                                         |
| [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) [FPS\_RES\_Type](#a3c1df956eda8f33eb06d11d024147870) | [fps\_getPropInt](#aabd8ab15a7fd2ef1b07c2f290ce2a733) (int16\_t handle, [FPS\_PROP\_INT\_Type](#af96966f9c2d007371a573af52137396c) prop, int \&propValue)                  |
| [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) [FPS\_RES\_Type](#a3c1df956eda8f33eb06d11d024147870) | [fps\_getPropString](#a70ed6204aba42111ed075782c8f6d4f7) (int16\_t handle, [FPS\_PROP\_STRING\_Type](#a94a6e9df02d10dc416e0a1e1b0b6dde7) prop, std::string \&propValue)    |
| [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) [FPS\_RES\_Type](#a3c1df956eda8f33eb06d11d024147870) | [fps\_setPropInt](#a1da91c3ff4fec25324382d2f0a5bd7f4) (int16\_t handle, [FPS\_PROP\_INT\_Type](#af96966f9c2d007371a573af52137396c) prop, int \&newPropValue)               |
| [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) [FPS\_RES\_Type](#a3c1df956eda8f33eb06d11d024147870) | [fps\_setPropString](#aa212398e5fd76ad41813af715e9c133e) (int16\_t handle, [FPS\_PROP\_STRING\_Type](#a94a6e9df02d10dc416e0a1e1b0b6dde7) prop, std::string \&newPropValue) |
| [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) [FPS\_RES\_Type](#a3c1df956eda8f33eb06d11d024147870) | [fps\_capture\_start](#aef6cf8111b7458ae47e9757475c6a6be) (int16\_t handle, [resultCallbackType](#a1533c279c5718316ff33db1874a98c2e) cb, void \*dataptr)                   |
| [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) [FPS\_RES\_Type](#a3c1df956eda8f33eb06d11d024147870) | [fps\_capture\_stop](#af516c30db101eb73dfaa9e003c3bd453) (int16\_t handle)                                                                                                 |
| [DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string                                          | [fps\_GetVersion](#a5b5afa88c2187fe3caa65bce8eb8088e) ()                                                                                                                   |

### TypedefDocumentation <a href="#typedef-documentation" id="typedef-documentation"></a>

### resultCallbackType <a href="#a1533c279c5718316ff33db1874a98c2e" id="a1533c279c5718316ff33db1874a98c2e"></a>

typedef void(\\\* resultCallbackType) (void \\\*dataptr, \[FPS\_CB\_Type]\(#a5d7a8d9c16c82913bda07e2105783e0b) msgType, int width, std::vector\\< unsigned char \\> [rawData](/adk-5.0-programmers-guide/readme/files/dir_44d926a17fc606d3c25449ba60427c63/dir_048f823fee1bfb22502a8732b9a001aa/titusstubs_8cpp.md#structraw_data))

callback method of capture\_start

**Parameters**

**dataptr** - reference to sender **msgType** - identifies the kind of callback data **width** - information about the picture width **rawData** - raw data of the message delivered as vector of unsigned chars

### EnumerationType Documentation <a href="#enumeration-type-documentation" id="enumeration-type-documentation"></a>

### FPS\_CB\_Type <a href="#a5d7a8d9c16c82913bda07e2105783e0b" id="a5d7a8d9c16c82913bda07e2105783e0b"></a>

enum \[FPS\_CB\_Type]\(#a5d7a8d9c16c82913bda07e2105783e0b)

enumeration of callback types

|                                           |                                                                |
| ----------------------------------------- | -------------------------------------------------------------- |
| Enumerator                                |                                                                |
| FPS\_CB\_DATA                             | data read successfully                                         |
| FPS\_CB\_ERROR                            | error occurred, see details in the data vector of the callback |
| FPS\_CB\_INFO\_BACKWARD\_MOVEMENT         | backward movement                                              |
| FPS\_CB\_INFO\_BAD\_QUALITY               | bad quality, try again                                         |
| FPS\_CB\_INFO\_CALIB\_START               | calib start                                                    |
| FPS\_CB\_INFO\_CENTER\_AND\_PRESS\_HARDER | center and press harder                                        |
| FPS\_CB\_INFO\_CLEAN\_SENSOR              | clean the sensor                                               |
| FPS\_CB\_INFO\_CONSOLIDATION\_FAIL        | consolidation fail                                             |
| FPS\_CB\_INFO\_CONSOLIDATION\_SUCCEED     | consolidation succeed                                          |
| FPS\_CB\_INFO\_ENROLL\_START              | enroll start                                                   |
| FPS\_CB\_INFO\_ENROLL\_PROGRESS           | enroll progress                                                |
| FPS\_CB\_INFO\_FINGER\_DETECT\_START      | detect start                                                   |
| FPS\_CB\_INFO\_FINGERLEFT                 | position finger : exceeding left boundaries                    |
| FPS\_CB\_INFO\_FINGERRIGHT                | position finger : exceeding right boundaries                   |
| FPS\_CB\_INFO\_FINGERTOP                  | position finger : exceeding top boundaries                     |
| FPS\_CB\_INFO\_FINGERBOTTOM               | position finger : exceeding bottom boundaries                  |
| FPS\_CB\_INFO\_GOOD\_IMAGE                | good image                                                     |
| FPS\_CB\_INFO\_GUI\_FINISH                | gui finish                                                     |
| FPS\_CB\_INFO\_GUI\_FINISH\_DETECT\_START | gui finish detect start                                        |
| FPS\_CB\_INFO\_GUI\_FINISH\_FAIL          | gui finish fail                                                |
| FPS\_CB\_INFO\_GUI\_FINISH\_SUCCEED       | gui finished succeed                                           |
| FPS\_CB\_INFO\_IMAGE\_PROCESSED           | image processed                                                |
| FPS\_CB\_INFO\_JOINT\_DETECTED            | joint detected                                                 |
| FPS\_CB\_INFO\_KEEP\_FINGER               | keep finger on sensor                                          |
| FPS\_CB\_INFO\_NO\_FINGER                 | no finger                                                      |
| FPS\_CB\_INFO\_PROCESSING\_IMAGE          | processing image                                               |
| FPS\_CB\_INFO\_PUT\_FINGER                | put finger number 1                                            |
| FPS\_CB\_INFO\_PUT\_FINGER2               | put finger number 2                                            |
| FPS\_CB\_INFO\_PUT\_FINGER3               | put finger number 3                                            |
| FPS\_CB\_INFO\_PUT\_FINGER4               | put finger number 4                                            |
| FPS\_CB\_INFO\_PUT\_FINGER5               | put finger number 5                                            |
| FPS\_CB\_INFO\_REMOVE\_FINGER             | remove finger                                                  |
| FPS\_CB\_INFO\_START                      | start                                                          |
| FPS\_CB\_INFO\_SWIPE\_IN\_PROGRESS        | swipe in progress                                              |
| FPS\_CB\_INFO\_TOO\_DARK                  | image too dark                                                 |
| FPS\_CB\_INFO\_TOO\_DRY                   | too dry                                                        |
| FPS\_CB\_INFO\_TOO\_FAST                  | too fast                                                       |
| FPS\_CB\_INFO\_TOO\_HIGH                  | too hight                                                      |
| FPS\_CB\_INFO\_TOO\_LEFT                  | too left                                                       |
| FPS\_CB\_INFO\_TOO\_LIGHT                 | image too light                                                |
| FPS\_CB\_INFO\_TOO\_LOW                   | too low                                                        |
| FPS\_CB\_INFO\_TOO\_RIGHT                 | too right                                                      |
| FPS\_CB\_INFO\_TOO\_SHORT                 | too short                                                      |
| FPS\_CB\_INFO\_TOO\_SKEWED                | too skewed                                                     |
| FPS\_CB\_INFO\_TOO\_SMALL                 | too small                                                      |
| FPS\_CB\_INFO\_TOO\_STRANGE               | too strange                                                    |
| FPS\_CB\_INFO\_TOUCH\_SENSOR              | touch sensor                                                   |
| FPS\_CB\_INFO\_VERIFY\_START              | verify start                                                   |
| FPS\_CB\_PICTURE                          | picture in raw data format                                     |
| FPS\_CB\_ANSI\_DATA                       | picture in ansi format                                         |
| FPS\_CB\_ISO\_DATA                        | picture in iso format                                          |
| FPS\_CB\_PGM\_DATA                        | picture in pgm format                                          |

### FPS\_IMG\_Type <a href="#af3c1346c7455895cfa8c46ccffdf7d50" id="af3c1346c7455895cfa8c46ccffdf7d50"></a>

enum \[FPS\_IMG\_Type]\(#af3c1346c7455895cfa8c46ccffdf7d50)

enumeration of desired image type, standard is RAW

|                |                                                 |
| -------------- | ----------------------------------------------- |
| Enumerator     |                                                 |
| FPS\_IMG\_RAW  | Image will be scanned in RAW format of sensor   |
| FPS\_IMG\_PGM  | Image will be converted to PGM format           |
| FPS\_IMG\_ANSI | Image will be converted to ANSI format          |
| FPS\_IMG\_ISO  | Image will be converted to ISO format           |
| FPS\_IMG\_ALL  | All image formats will be delivered in callback |

### FPS\_PROP\_INT\_Type <a href="#af96966f9c2d007371a573af52137396c" id="af96966f9c2d007371a573af52137396c"></a>

enum \[FPS\_PROP\_INT\_Type]\(#af96966f9c2d007371a573af52137396c)

enumeration of integer properties

|                                                   |                                             |
| ------------------------------------------------- | ------------------------------------------- |
| Enumerator                                        |                                             |
| FPS\_PROP\_INT\_VERSION                           | property of version informations            |
| FPS\_PROP\_INT\_INFO                              | property of general informations            |
| FPS\_PROP\_INT\_MINNEXTVERSION                    | property of minimal next version            |
| FPS\_PROP\_INT\_VARIANT                           | property of variant                         |
| FPS\_PROP\_INT\_FUNCTIONALITY                     | property of functionality                   |
| FPS\_PROP\_INT\_CONFIG                            | property of configuration                   |
| FPS\_PROP\_INT\_ID                                | property of id                              |
| FPS\_PROP\_INT\_AUTHENTIFYID                      | property of authentify id                   |
| FPS\_PROP\_INT\_USAGE                             | property of usage                           |
| FPS\_PROP\_INT\_SENSORTYPE                        | property of sensortype                      |
| FPS\_PROP\_INT\_IMAGEWIDTH                        | property of max image width                 |
| FPS\_PROP\_INT\_IMAGEHEIGHT                       | property of max image height                |
| FPS\_PROP\_INT\_MAXGRABWINDOW                     | property of max grab window                 |
| FPS\_PROP\_INT\_COMPANIONVENDORCODE               | property of companion vendor code           |
| FPS\_PROP\_INT\_VERSIONEXT                        | property of version extension               |
| FPS\_PROP\_INT\_SYSTEMID                          | property of system id                       |
| FPS\_PROP\_INT\_DATATYPE                          | property of datatype                        |
| FPS\_PROP\_INT\_IMAGE\_QUALITY\_LAST              | property of last image quality              |
| FPS\_PROP\_INT\_IMAGE\_NUMBER\_OF\_MINUTIAE\_LAST | property of number of minutiae in last scan |
| FPS\_PROP\_INT\_IMAGE\_SIZE                       | property of image size for iso/ansi         |

### FPS\_PROP\_STRING\_Type <a href="#a94a6e9df02d10dc416e0a1e1b0b6dde7" id="a94a6e9df02d10dc416e0a1e1b0b6dde7"></a>

enum \[FPS\_PROP\_STRING\_Type]\(#a94a6e9df02d10dc416e0a1e1b0b6dde7)

enumeration of string properties

|                               |                                               |
| ----------------------------- | --------------------------------------------- |
| Enumerator                    |                                               |
| FPS\_PROP\_STRING\_EXTINFO    | f.e. extended info from sensor in json format |
| FPS\_PROP\_STRING\_INFO       | f.e. raw data from sensor in json format      |
| FPS\_PROP\_STRING\_TYPE       | f.e. sensor type                              |
| FPS\_PROP\_STRING\_HWINFO     | f.e. extended informations of used hardware   |
| FPS\_PROP\_STRING\_GUID       | f.e. guid delivered by sensor                 |
| FPS\_PROP\_STRING\_SYSTEMNAME | f.e. system name delivered by sensor          |

### FPS\_RES\_Type <a href="#a3c1df956eda8f33eb06d11d024147870" id="a3c1df956eda8f33eb06d11d024147870"></a>

enum \[FPS\_RES\_Type]\(#a3c1df956eda8f33eb06d11d024147870)

enumeration of result types

|                           |                                         |
| ------------------------- | --------------------------------------- |
| Enumerator                |                                         |
| FPS\_RES\_SUCCESS         | function was successful                 |
| FPS\_RES\_FAILURE         | function returned with failure          |
| FPS\_RES\_NO\_PROP        | function returned with no such property |
| FPS\_RES\_INFO\_NOT\_READ | function returned fpsInfo not read      |

### FunctionDocumentation <a href="#function-documentation" id="function-documentation"></a>

### fps\_capture\_start() <a href="#aef6cf8111b7458ae47e9757475c6a6be" id="aef6cf8111b7458ae47e9757475c6a6be"></a>

[DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) \[FPS\_RES\_Type]\(#a3c1df956eda8f33eb06d11d024147870) vfifps::fps\_capture\_start

start captureing fingerprint from device (asyncron). Install a callback that indicates successful read, errors or user information.

**Parameters**

**handle** - handle to fingerprint sensor object **cb** - callback for user instruction, results **dataptr** - ptr to datacontext of caller

#### Returns

success indicator cf. FPS\_RES\_Type

### fps\_capture\_stop() <a href="#af516c30db101eb73dfaa9e003c3bd453" id="af516c30db101eb73dfaa9e003c3bd453"></a>

[DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) \[FPS\_RES\_Type]\(#a3c1df956eda8f33eb06d11d024147870) vfifps::fps\_capture\_stop

stop captureing fingerprint from device

**Parameters**

**handle** - handle to fingerprint sensor object

#### Returns

success indicator cf. FPS\_RES\_Type

### fps\_close() <a href="#a1bcf940c8fae055399fa4bbca5706857" id="a1bcf940c8fae055399fa4bbca5706857"></a>

[DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) \[FPS\_RES\_Type]\(#a3c1df956eda8f33eb06d11d024147870) vfifps::fps\_close

close connection to fingerprint sensor

**Parameters**

**handle** - handle to fingerprint sensor object

#### Returns

success indicator cf. FPS\_RES\_Type

### fps\_getPropInt() <a href="#aabd8ab15a7fd2ef1b07c2f290ce2a733" id="aabd8ab15a7fd2ef1b07c2f290ce2a733"></a>

[DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) \[FPS\_RES\_Type]\(#a3c1df956eda8f33eb06d11d024147870) vfifps::fps\_getPropInt

read property of integer type from fingerprint sensor

**Parameters**

**handle** - handle to fingerprint sensor object **prop** - integer property to read **propValue** - out variable where the read result is stored

#### Returns

success indicator cf. FPS\_RES\_Type

### fps\_getPropString() <a href="#a70ed6204aba42111ed075782c8f6d4f7" id="a70ed6204aba42111ed075782c8f6d4f7"></a>

[DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) \[FPS\_RES\_Type]\(#a3c1df956eda8f33eb06d11d024147870) vfifps::fps\_getPropString

read property of string type from fingerprint sensor

**Parameters**

**handle** - handle to fingerprint sensor object **prop** - string property to read **propValue** - out variable where the read result is stored

#### Returns

success indicator cf. FPS\_RES\_Type

### fps\_GetVersion() <a href="#a5b5afa88c2187fe3caa65bce8eb8088e" id="a5b5afa88c2187fe3caa65bce8eb8088e"></a>

[DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) std::string vfifps::fps\_GetVersion

get version of adk library

### fps\_open() <a href="#a0e210dd7087b2ce621faa8ede70b52fc" id="a0e210dd7087b2ce621faa8ede70b52fc"></a>

[DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) int16\_t vfifps::fps\_open

open connection to fingerprint sensor

**Parameters**

**device** - device identifier to open. If empty automatic device detection.

#### Returns

handle to opened finger print sensor

### fps\_setPropInt() <a href="#a1da91c3ff4fec25324382d2f0a5bd7f4" id="a1da91c3ff4fec25324382d2f0a5bd7f4"></a>

[DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) \[FPS\_RES\_Type]\(#a3c1df956eda8f33eb06d11d024147870) vfifps::fps\_setPropInt

write property of integer type to fingerprint sensor

**Parameters**

**handle** - handle to fingerprint sensor object **prop** - integer property to write **newPropValue** - in variable where the data to write is stored

#### Returns

success indicator cf. FPS\_RES\_Type

### fps\_setPropString() <a href="#aa212398e5fd76ad41813af715e9c133e" id="aa212398e5fd76ad41813af715e9c133e"></a>

[DllSpec](/adk-5.0-programmers-guide/readme/files/dir_15b7eb99384c20f55db7776b7b1ecdad/dir_7d99a5752ef00d9a9478541a793df8d8/dir_b95d7ee73b2963b5e37f0a7269e7a4c6/sound_8h.md#ad7c2e1cb200073ed64c64285a5f37231) \[FPS\_RES\_Type]\(#a3c1df956eda8f33eb06d11d024147870) vfifps::fps\_setPropString

write property of string type from fingerprint sensor

**Parameters**

**handle** - handle to fingerprint sensor object **prop** - string property to write **newPropValue** - in variable where the data to write is stored

#### Returns

success indicator cf. FPS\_RES\_Type


---

# 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/namespaces/namespacevfifps.md?ask=<question>&goal=<endgoal>
```

`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.
