Copyright Digital Equipment Corp. All rights reserved.

CSSM_ModuleLoad

NAME
  CSSM_ModuleLoad - Initialize the security service module (CDSA)

SYNOPSIS
  # include <cssm.h>

       CSSM_RETURN CSSMAPI CSSM_ModuleLoad
       (const CSSM_GUID *ModuleGuid,
       CSSM_KEY_HIERARCHY KeyHierarchy,
       CSSM_API_ModuleEventHandler AppNotifyCallback,
       void* AppNotifyCallbackCtx)

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

PARAMETERS
  ModuleGuid (input)
          The GUID of the module selected for loading.

  KeyHierarchy (input)
          The CSSM_KEY_HIERARCHY option directing CSSM what embedded
          key to use when verifying integrity of the named module.

  AppNotifyCallback (input/optional)
          The event notification function provided by the caller. This
          defines the callback for event notifications from the loaded
          (and later attached) service module.

  AppNotifyCallbackCtx (input/optional)
          When the selected service module raises an event, this context
          is passed as an input to the event handler specified by
          AppNotifyCallback.  CSSM does not interpret or modify the
          value of AppNotifyCallbackCtx.

DESCRIPTION
  This function initializes the security service module. Initialization
  includes registering the application's module-event handler and
  enabling events with the security service service module.  The
  application can choose to provide an event handler function to receive
  notification of insert, remove, and fault events. The specified event
  handler is the single callback point for all attached sessions with
  the specified service module.

  The function CSSM_Init() must be invoked prior to calling
  CSSM_ModuleLoad(). The function CSSM_ModuleAttach() can be invoked
  multiple times per call to CSSM_ModuleLoad().

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_INVALID_GUID
       CSSMERR_CSSM_ADDIN_LOAD_FAILED
       CSSMERR_CSSM_EMM_LOAD_FAILED
       CSSMERR_CSSM_INVALID_KEY_HIERARCHY

SEE ALSO
  Intel CDSA Application Developer's Guide (see CDSA)