HP OpenVMS Systems Documentation

Content starts here
HP Open Source Security for OpenVMS Volume 1: Common Data Security Architecture > Human Recognition Service (HRS) API Functions

HRS_Import

  Table of Contents

  Glossary

  Index

NAME

CSSM_HRS_Import, HRS_Import — Imports non-realtime raw biometric data to construct a BIR

SYNOPSIS

#include <hrs.h>

API

CSSM_RETURN CSSMAPI CSSM_HRS_Import
(CSSM_HRS_HANDLE ModuleHandle,
const CSSM_DATA *InputData,
CSSM_HRS_BIR_BIOMETRIC_DATA_FORMAT InputFormat,
CSSM_HRS_BIR_PURPOSE Purpose,
CSSM_HRS_BIR_HANDLE_PTR ConstructedBIR);

SPI

CSSM_RETURN CSSMHRI HRS_Import
(CSSM_HRS_HANDLE ModuleHandle,
const CSSM_DATA *InputData,
CSSM_HRS_BIR_BIOMETRIC_DATA_FORMAT InputFormat,
CSSM_HRS_BIR_PURPOSE Purpose,
CSSM_HRS_BIR_HANDLE_PTR ConstructedBIR);

LIBRARY

HRS Extensible Module Manager (cdsa$inhrsemm_shr.exe)

PARAMETERS

The parameter definitions are the same for the API and the SPI.

ModuleHandle (input) 

The handle of the attached HRS service provider.

InputData (input)  

A pointer to image/stream data to import into a ProcessedBIR. The image/stream conforms to the standard identified by InputFormat.

InputFormat (input)  

The format of the InputData.

Purpose (input)  

A value indicating the Enroll purpose.

ConstructedBIR (output)  

A handle to a BIR constructed from the imported biometric data. This BIR may be either an Intermediate or Processed BIR (as indicated in the header).

DESCRIPTION

This function imports non-realtime raw biometric data to construct a BIR for the purpose specified. InputData identifies the memory buffer containing the raw biometric data, while InputFormat identifies the form of the raw biometric data.

The function returns a handle to the ConstructedBIR.

If the application needs to acquire the BIR either to store it in a database or to send it to a server, the application can retrieve the data with the HRS_GetBIRFromHandle() function, or store it directly using HRS_DbStoreBIR().

RETURN VALUE

A CSSM_RETURN value indicating success or specifying a particular error condition. The value CSSM_OK indicates success. All other values represent an error condition.

ERRORS

Errors are described in the CDSA Technical Standard.

CSSMERR_CSSM_NOT_INITIALIZED
CSSMERR_CSSM_FUNCTION_FAILED
CSSMERR_CSSM_FUNCTION_NOT_IMPLEMENTED
CSSMERR_CSSM_FUNCTION_INTEGRITY_FAIL
CSSMERR_HRS_FUNCTION_NOT_SUPPORTED
CSSMERR_HRS_PURPOSE_NOT_SUPPORTED
CSSMERR_HRS_TOO_MANY_HANDLES
CSSMERR_HRS_UNABLE_TO_IMPORT
CSSMERR_HRS_UNSUPPORTED_FORMAT