Library /sys$common/syshlp/helplib.hlb  —  CDSA  CDSA_API, CSSM SPI ModuleLoad
 NAME
   CSSM_SPI_ModuleLoad - Initialize process between CSSM and the add-in
                         service module (CDSA)

 SYNOPSIS
   # include <cssm.h>

        CSSM_RETURN CSSMSPI CSSM_SPI_ModuleLoad
        (const CSSM_GUID *CssmGuid,
        const CSSM_GUID *ModuleGuid,
        CSSM_SPI_ModuleEventHandler CssmNotifyCallback,
        void* CssmNotifyCallbackCtx)

 LIBRARY
   Common Security Services Manager library (CDSA$INCSSM300_SHR.EXE)

 PARAMETERS
   CssmGuid (input)
           The CSSM_GUID of the caller. Used to locate the caller's
           signed manifest credentials.

   ModuleGuid (input)
           The CSSM_GUID of the invoked service provider module. Used to
           locate the module's signed manifest credentials.

   CssmNotifyCallback (input)
           A function pointer for the CSSM event handler that manages
           events of type CSSM_MODULE_EVENT.

   CssmNotifyCallbackCtx (input)
           The context to be returned to CSSM as input on each callback
           to the event handler defined by CssmNotifyCallback.

 DESCRIPTION
   This function completes the module initialization process between CSSM
   and the add-in service module. Before invoking this function, CSSM
   verifies the add-in service module's manifest credentials. If the
   credentials verify this module is loaded (physically if required), the
   CSSM_SPI_ModuleLoad() function is invoked.

   The CssmGuid parameter identifies the caller and should be used by the
   module to locate the caller's signed manifest credentials and to
   complete integrity verification and secure linkage checks on the caller.
   The ModuleGuid identifies the invoked module and should be used by the
   module to locate its credentials and to complete an integrity
   self-check.

   The CssmNotifyCallback and CssmNotifyCallbackCtx parameters define a
   callback and callback context respectively.  The module must retain this
   information for later use. The module should use the callback to notify
   CSSM of module events of type CSSM_MODULE_EVENT in any ongoing, attached
   sessions.

 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.

 SEE ALSO
   Books

   Intel CDSA Application Developer's Guide (see CDSA)

   Other Help Topics

   Functions: CSSM_SPI_ModuleAttach
              CSSM_SPI_ModuleUnload
Close Help