HRS_DbGetNextBIR

NAME

CSSM_HRS_DbGetNextBIR, HRS_DbGetNextBIR — Retrieves the BIR identified by the Cursor parameter

SYNOPSIS

#include <hrs.h>

API

CSSM_RETURN CSSMAPI CSSM_HRS_DbGetNextBIR
        (CSSM_HRS_HANDLE ModuleHandle,
        CSSM_HRS_DB_CURSOR_PTR Cursor,
        CSSM_HRS_BIR_HANDLE_PTR RetrievedBIR,
        CSSM_GUID_PTR Guid);

SPI

CSSM_RETURN CSSMHRI HRS_DbGetNextBIR
        (CSSM_HRS_HANDLE ModuleHandle,
        CSSM_HRS_DB_CURSOR_PTR Cursor,
        CSSM_HRS_BIR_HANDLE_PTR RetrievedBIR,
        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.
`Cursor` (input/output)		A handle indicating which record to retrieve.
`RetrievedBIR` (output)		A handle to the retrieved BIR.
`Guid` (output)		The GUID that uniquely identifies the retrieved BIR in the database.

DESCRIPTION

This function retrieves the BIR identified by the KeyValue parameter in the open database identified by the DbHandle parameter.

The BIR is copied into the service provider’s storage and a handle to it is returned. The Cursor is set to point to the next record, or the first record in the database if the retrieved BIR is the last.

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