~~NOTOC~~
[[face_api]] > [[BS2_ScanFace]]

----

===== BS2_ScanFace=====
''IR Face based'' Scans the face from a device and extracts template and image data.
==== Declaration ====
<code cpp>
#include "BS_API.h"

int BS2_ScanFace(void* context, uint32_t deviceId, BS2Face* face, uint8_t erollmentThreshold, OnReadyToScan ptrReadyToScan);
</code>

<callout type="info">
[[Face api#BS2Face|See BS2Face Structure]]
</callout>
==== Parameter ====
  * [In] ''//context//'' : Context
  * [In] ''//deviceId//'' : Device ID
  * [Out] ''//face//'' : Pointer to store the face data  
  * [In] ''//erollmentThreshold//'' : Required enrollment threshold - Please refer to the [[configuration_api#bs2faceconfig|BS2FaceConfig.enrollThreshold]]
  * [Out] ''//ptrReadyToScan//'' : Callback function that is called when it's ready to scan a face
==== Return Value ====
If successfully done, ''BS_SDK_SUCCESS'' will be returned. \\
If there is an error, the corresponding error code will be returned.
\\