CleanupKeyContext Event

Fires when the application-defined data stored in a registry key context needs be cleaned up.

Syntax

ANSI (Cross Platform)
virtual int FireCleanupKeyContext(CBRegistryCleanupKeyContextEventParams *e);

typedef struct {
  void *KeyContext;
  int ResultCode;
  int reserved;
} CBRegistryCleanupKeyContextEventParams;

Unicode (Windows)
virtual INT FireCleanupKeyContext(CBRegistryCleanupKeyContextEventParams *e);

typedef struct {
  LPVOID KeyContext;
  INT ResultCode;
  INT reserved;
} CBRegistryCleanupKeyContextEventParams;
#define EID_CBREGISTRY_CLEANUPKEYCONTEXT 25

virtual INT CBFSFILTER_CALL FireCleanupKeyContext(LPVOID &lpKeyContext, INT &iResultCode);

Remarks

This event fires when the specified KeyContext is about to be discarded, giving applications a chance to clean up any information stored in it. Please refer to the Contexts topic for more information.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), set it to a non-zero value to report an appropriate error. Please refer to the Error Reporting and Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.
Copyright (c) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 C++ Edition - Version 20.0 [Build 8317]