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_DbQueryBIR

  Table of Contents

  Glossary

  Index

NAME

CSSM_HRS_DbQueryBIR, HRS_DbQueryBIR — Returns a pointer to the GUID of a BIR in an open database

SYNOPSIS

#include <hrs.h>

API

CSSM_RETURN CSSMAPI CSSM_HRS_DbQueryBIR
(CSSM_HRS_HANDLE ModuleHandle,
CSSM_HRS_DB_HANDLE DbHandle,
const CSSM_HRS_INPUT_BIR *BIRToQuery,
CSSM_GUID_PTR Guid);

SPI

CSSM_RETURN CSSMHRI HRS_DbQueryBIR
(CSSM_HRS_HANDLE ModuleHandle,
CSSM_HRS_DB_HANDLE DbHandle,
const CSSM_HRS_INPUT_BIR *BIRToQuery,
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.

DbHandle (input)  

The handle to the open database.

BIRToQuery (input)  

The BIR to be queried in the open database (either the BIR, its handle, or the key to the BIR in another open database).

Guid (output) 

The GUID that uniquely identifies the BIR in the database.

DESCRIPTION

This function returns a pointer to the GUID of a BIR identified by the BIRToQuery parameter, if the BIR is in the open database identified by the DbHandle parameter. Otherwise, CSSMERR_HRS_RECORD_NOT_FOUND is returned.

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_RECORD_NOT_FOUND