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_DbStoreBIR

  Table of Contents

  Glossary

  Index

NAME

CSSM_HRS_DbStoreBIR, HRS_DbStoreBIR — Stores a BIR in an open database

SYNOPSIS

#include <hrs.h>

API

CSSM_RETURN CSSMAPI CSSM_HRS_DbStoreBIR
(CSSM_HRS_HANDLE ModuleHandle,
const CSSM_HRS_INPUT_BIR *BIRToStore,
CSSM_HRS_DB_HANDLE DbHandle,
CSSM_GUID_PTR Guid);

SPI

CSSM_RETURN CSSMHRI HRS_DbStoreBIR
(CSSM_HRS_HANDLE ModuleHandle,
const CSSM_HRS_INPUT_BIR *BIRToStore,
CSSM_HRS_DB_HANDLE DbHandle,
CSSM_GUID_PTR Guid);

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.

BIRToStore (input)  

The BIR to be stored in the open database (either the BIR or its handle, or the index to it in another open database).

DbHandle (input)  

The handle to the open database.

Guid (output)  

A GUID that uniquely identifies the new BIR in the database. This GUID cannot be changed. To associate a different BIR with the user, it is necessary to delete the old one, store a new one in the database, and then replace the old GUID with the new one in the application account database.

DESCRIPTION

This function stores the BIR identified by the BIRToStore parameter in the open database identified by the DbHandle parameter. If the BIRToStore is identified by a BIR handle, the input BIR handle is freed. If the BIRToStore is identified by a database key value, the BIR is copied to the open database.

A new GUID is assigned to the new BIR in the database, and this GUID can be used as a key value to access the BIR later.

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