CleanupKeyContext Event

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

Syntax

class CBRegistryCleanupKeyContextEventParams {
public:
  void *KeyContext();
  int ResultCode();
  void SetResultCode(int iResultCode);
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void CleanupKeyContext(CBRegistryCleanupKeyContextEventParams *e);

// Or, subclass CBRegistry and override this emitter function.
virtual int FireCleanupKeyContext(CBRegistryCleanupKeyContextEventParams *e) {...}

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.