VMS Help  —  CDSA  CDSA_API, HRS FreeBIRHandle
 NAME
   CSSM_HRS_FreeBIRHandle, HRS_FreeBIRHandle - Free memory associated
                                               with BIR Handle

 SYNOPSIS
   #include <hrs.h>

 API
   CSSM_RETURN CSSMAPI CSSM_HRS_FreeBIRHandle(
                                    CSSM_HRS_HANDLE ModuleHandle,
                                    CSSM_HRS_BIR_HANDLE Handle);
 SPI
   CSSM_RETURN CSSMHRI HRS_FreeBIRHandle(
                                    CSSM_HRS_HANDLE ModuleHandle,
                                    CSSM_HRS_BIR_HANDLE Handle);

 LIBRARY
   HRS Extensible Module Manager (CDSA$INHRSEMM_SHR.EXE)

 PARAMETERS
   ModuleHandle (input)
         The handle of the attached HRS service provider.

   Handle (input)
         The BIR Handle to be freed.

 DESCRIPTION
   Frees the memory and resources associated with the specified BIR
   Handle.  The associated BIR is no longer referenceable through that
   handle.  If necessary, the application must make the BIR presistent
   either in an HRS-managed database or an application-managed database
   before freeing the handle.

 RETURN VALUE
   A CSSM_RETURN value indicating success or specifying an 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
Close Help