AS ISO IEC 19784.2 pdf download – Information technology—Biometric application programming interface Part 2: Biometric archive function provider interface

AS ISO IEC 19784.2 pdf download – Information technology—Biometric application programming interface Part 2: Biometric archive function provider interface
5.2.5 BioAFPI_QueryUnits
BioAPI_RETURN BioAP工 BioAFPI_QueryUnits
(const BioAPI__UUID *BafpUuid,
BioAPI__UNIT_SCHEMA* *UnitschemaArray ,uint32_t*NumberOfElements ) ;
Description
This function returns an array of BioAPl Unit schemas (see 7.55 of ISOIEC19784-1:2006),which aremanaged by the given BAFP and are currently in the inserted state.
NOTE When the BSP calls the function BioAFPl_QueryUnits of a BFP, the BFP allocates memory for the data to bereturned to the BSP. In some implementation architectures, the BSP will simply pass to the framework the data and theaddresses exactly as returned by the BFP because the framework wil interpret the addresses in the same way as the BFPand will be able to access the data that the BFP has placed at those addresses. In other implementation architectures,the BSP will need to move all the data returned by the BFP to newly allocated memory blocks accessible to the framework,and will call BioAFPl_Free after copying each memory block but before returning from the BioSPl_QueryUnits call. n theformer case,when the framework calls BioSPl_Free, the BSP will make a corresponding call to BioAFPL_Free. In thelatter case, the calls to BioSPl_Free will be handled internally by the BSP. However, such differences in the behavior ofthe BSP are not visible to the Framework.
The memory block containing the array shall be freed by the BSP via a call to BioAFPl_Free when it is nolonger needied by the BSP. The memory block pointed to by the UnitProperty member within each element ofthe array shall also be freed by the BSP via a call to BioAFPl_Free when it is no longer needed by the BSP.
This function shall only be called after BioAFPl_Load has been called for the specified BFP, and shall not becalled after BioAFP_Unload has been called for the BFP.
There is no requirement that a unit ID, returned by this function for a given BioAPl unit, be made available withthe same unit ID value by the BSP to the framework. A BSP is free to translate any unit lD value (provided bya BFP) into a different unit ID value before providing it to the framework. The purpose of such a translationwould be to avoid the existence of duplicate unit lDs within the scope of the BSP, which might happen when aBSP is using two or more BFPs of the same category, or when a BSP is using an archive BFP while alsodirectly managing archive units.
Parameters
BafpUuid (input)-The unique identifier for the BAFP for which the information is to be returned.
UnitSchemaArray (output) – A pointer to an address of the array of elements of typeBioAPIl_UNIT_SCHEMA (allocated by the BSP – but see note above) containing the unit schemainformation.
NumberOfElements (output) – A pointer to the number of elements in the array,which are managedby the given BAFP and are currently in the inserted state.
Return Value
A BioAPl_RETURN value indicating success or specifying a particular error condition. The valueBioAPl_OK indicates success.All other values represent an error condition.
5.2.6BioAFPI_Free
BioAPI_RETURN BioAPI BioAFPI_Free
(void *Ptr) ;
Description
This function causes the space pointed to by Ptr to be deallocated. lf Ptr is NULL, no action occurs.Otherwise, if Ptr does not match a pointer earlier returned by the BioAFPl functions, or if the space alreadyhas been deallocated by a call to BioAFPl_Free, the behavior is undefined.
Parameters
Ptr ( inpuf) – A pointer to the memory to free.
Return Value
A BioAPl_RETURN value indicating success or specifying a particular error condition. The valueBioAPl_OK indicates success. All other values represent an error condition.
Errors
5.2.7 BioAFPI_ControlUnit
BioAPI_RETURN BioAPI BioAFPI_ControlUnit
(BioAPI_UNIT_ID UnitID,
uint32_t ControlCode,
const BioAPI_DATA *InputData,
BioAPI_DATA *OutputData) ;
Description
This function sends control data to the BioAPI Unit and receives status or operation data from there. The content of the ControlCode, the send (input) data, and the receive (output) data will be specified in the related interface specification for this BioAPI Unit.