ICertExit::Notify method (certexit.h)

Article
02/22/2024

The Notify method is called by the server engine to notify an exit module that an event has occurred.

Syntax

HRESULT Notify(
  [in] LONG ExitEvent,
  [in] LONG Context
);

Parameters

[in] ExitEvent

A mask that indicates the kind of exit event that has occurred. The mask can have one of the following flag-bits set.

Value	Meaning
EXITEVENT_CERTISSUED	Certificate issued.
EXITEVENT_CERTPENDING	Certificate pending.
EXITEVENT_CERTDENIED	Certificate denied.
EXITEVENT_CERTREVOKED	Certificate revoked.
EXITEVENT_CERTRETRIEVEPENDING	Successful call to ICertRequest::RetrievePending.
EXITEVENT_CRLISSUED	Certificate revocation list (CRL) issued.
EXITEVENT_SHUTDOWN	Certificate Services shutdown.

[in] Context

Specifies a context handle that can be used to get properties associated with the event from the ICertServerExit interface.

Return value

VB

If the method succeeds, the method returns S_OK.

If the method fails, it returns an HRESULT value that indicates the error. For a list of common error codes, see Common HRESULT Values.

Remarks

If a certification authority is using multiple exit modules, Certificate Services will notify each exit module of the event (provided the exit module requested notification by means of Initialize). The order in which the exit modules are notified should not be assumed, nor should one exit module depend on the processing of another exit module. Each notified exit module must return from Notify before the next exit module will be notified.

Examples

#include <windows.h>
#include <stdio.h>
#include <Certexit.h>

STDMETHODIMP CCertExit::Notify(
    /* [in] */ LONG ExitEvent,
    /* [in] */ LONG Context)
{
    char *pszEvent;
    HRESULT hr = S_OK;

    switch (ExitEvent)
    {
    case EXITEVENT_CERTISSUED:
        //  Call application-specific function for issued certs.
        hr = MyEventCertIssued(Context);
        pszEvent = "certissued";
        break;

    case EXITEVENT_CERTPENDING:
        pszEvent = "certpending";
        break;

    case EXITEVENT_CERTDENIED:
        pszEvent = "certdenied";
        break;

    case EXITEVENT_CERTREVOKED:
        pszEvent = "certrevoked";
        break;

    case EXITEVENT_CERTRETRIEVEPENDING:
        pszEvent = "retrievepending";
        break;

    case EXITEVENT_CRLISSUED:
        pszEvent = "crlissued";
        break;

    case EXITEVENT_SHUTDOWN:
        //  Call application-specific function for shutdown.
        hr = MyEventShutdown();
        pszEvent = "shutdown";
        break;

    default:
        pszEvent = "Unexpected event";
        break;
    }

    if ( fDebug )
    {
        //  Display what took place.
        printf("Exit::Notify(%s=%x, context=%u) return=%x\n",
                      pszEvent,
                      ExitEvent,
                      Context,
                      hr);
    }

    return(hr);
}

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	certexit.h (include Certsrv.h)

Share via