HELPLIB.HLB  —  CDSA  CDSA_API, HRS DbSetCursor
 NAME
   CSSM_HRS_DbSetCursor, HRS_DbSetCursor

 SYNOPSIS

 #include <hrs.h>

 API
   CSSM_RETURN CSSMAPI CSSM_HRS_DbSetCursor(
                          CSSM_HRS_HANDLE ModuleHandle,
                          CSSM_HRS_DB_HANDLE DbHandle,
                          const CSSM_GUID *KeyValue,
                          CSSM_HRS_DB_CURSOR_PTR Cursor);
 SPI
   CSSM_RETURN CSSMHRI HRS_DbSetCursor(
                          CSSM_HRS_HANDLE ModuleHandle,
                          CSSM_HRS_DB_HANDLE DbHandle,
                          const CSSM_GUID *KeyValue,
                          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)            A handle to the open database.
   KeyValue (input)            The key into the database of the BIR to
                               which the Cursor is to be set.
   Cursor (output)             A handle that can be used to iterate
                               through the database from the retrieved
                               record.

 DESCRIPTION
   The Cursor is set to point to the record indicated by the KeyValue
   in the database identified by the DbHandle. A NULL value will set
   the cursor to the first record in the database.

 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.  See CDSA.

   CSSMERR_CSSM_NOT_INITIALIZED
   CSSMERR_CSSM_FUNCTION_FAILED
   CSSMERR_CSSM_FUNCTION_NOT_IMPLEMENTED
   CSSMERR_CSSM_FUNCTION_INTEGRITY_FAIL
   CSSMERR_HRS_RECORD_NOT_FOUND
Close Help