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_GetBIRFromHandle

  Table of Contents

  Glossary

  Index

NAME

CSSM_HRS_GetBIRFromHandle, HRS_GetBIRFromHandle — Retrieves the BIR associated with a BIR handle

SYNOPSIS

#include <hrs.h>

API

CSSM_RETURN CSSMAPI CSSM_HRS_GetBIRFromHandle
(CSSM_HRS_HANDLE ModuleHandle,
CSSM_HRS_BIR_HANDLE Handle,
CSSM_HRS_BIR_PTR *BIR);

SPI

CSSM_RETURN CSSMHRI HRS_GetBIRFromHandle
(CSSM_HRS_HANDLE ModuleHandle,
CSSM_HRS_BIR_HANDLE Handle,
CSSM_HRS_BIR_PTR *BIR);

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.

Handle (input)  

The handle of the BIR to be retrieved.

BIR (output)  

The retrieved BIR.

DESCRIPTION

This function retrieves the BIR associated with a BIR handle. The handle is invalidated. The HRS service provider allocates the storage for both the retrieved BIR structure and its data members, using the application’s memory allocation callback function.

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