CSSM_ModuleUnload

NAME

CSSM_ModuleUnload — Deregister event notification callbacks (CDSA)

SYNOPSIS

# include <cssm.h>

CSSM_RETURN CSSMAPI CSSM_ModuleUnload
(const CSSM_GUID *ModuleGuid,
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 unloading.
`AppNotifyCallback` (input/optional)
		The event notification function to be deregistered. The function must have been provided by the caller in `CSSM_ModuleLoad`().
`AppNotifyCallbackCtx` (input/optional)
		The event notification context that was provided in the corresponding call to `CSSM_ModuleLoad`().

DESCRIPTION

The function deregisters event notification callbacks for the caller identified by ModuleGuid. The CSSM_ModuleUnload() function is the analog call to CSSM_ModuleLoad(). If all callbacks registered with CSSM are removed, then CSSM unloads the service module that was loaded by calls to CSSM_ModuleLoad(). Calls to CSSM_ModuleUnload() that are not matched with a previous call to CSSM_ModuleLoad() result in an error.

The CSSM uses the three input parameters ModuleGuid, AppNotifyCallback, and AppNotifyCallbackCtx to uniquely identify registered callbacks.

This function should be invoked after all necessary calls to CSSM_ModuleDetach() have been performed.

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_ADDIN_UNLOAD_FAILED
CSSMERR_CSSM_EMM_UNLOAD_FAILED
CSSMERR_CSSM_EVENT_NOTIFICATION_CALLBACK_NOT_FOUND

CSSM_ModuleUnload

» Table of Contents

» Glossary

» Index