NAME
CSSM_HRS_DbGetBIR, HRS_DbGetBIR — Retrieves a BIR from an open database
SYNOPSIS
#include <hrs.h>
API
CSSM_RETURN CSSMAPI CSSM_HRS_DbGetBIR
(CSSM_HRS_HANDLE ModuleHandle,
CSSM_HRS_DB_HANDLE DbHandle,
const CSSM_GUID *KeyValue,
CSSM_HRS_BIR_HANDLE_PTR RetrievedBIR,
CSSM_HRS_DB_CURSOR_PTR Cursor); |
SPI
CSSM_RETURN CSSMHRI HRS_DbGetBIR
(CSSM_HRS_HANDLE ModuleHandle,
CSSM_HRS_DB_HANDLE DbHandle,
const CSSM_GUID *KeyValue,
CSSM_HRS_BIR_HANDLE_PTR RetrievedBIR,
CSSM_HRS_DB_CURSOR_PTR Cursor); |
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. |
| KeyValue (input) | | The key into the database
of the BIR to retrieve. |
| RetrievedBIR (output) | | A handle to the retrieved
BIR. |
| Cursor (output) | | A handle that can be used
to iterate through the database from the retrieved record. |
DESCRIPTION
This function retrieves the BIR identified by the Cursor parameter.
The BIR is copied into the service provider’s storage,
a handle to it is returned, and a pointer to the GUID that uniquely
identifies the BIR in the database is returned. The Cursor is
updated to the next record in the database, or to the first when
the end of the database is reached.
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_CURSOR_IS_INVALID
CSSMERR_HRS_END_OF_DATABASE
