API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

ISHELL_REGISTERHANDLER()

Brew Release
Brew MP 1.0.2
See Also
AEECLSID AEEHandlerType Error Codes IShell ISHELL_GetHandler
Description
This function provides a mechanism for a content viewer or protocol engine to register itself with the AEE shell. This allows other components to share its functionality when content or protocol types are encountered. As the handler is specified by class, it can be loaded dynamically on an as-needed basis. IShell allows only one handler to be associated with a scheme. To update a handler, the existing handler must be deleted from the database by calling ISHELL_RegisterHandler() with a 0 (zero) ClassID.
Params
pIShell
[]:
Pointer to the IShell interface object.
clsBase
[]:
Handler type (HTYPE_VIEWER, HTYPE_SOUND) base class, or interface ID. The interface must be based on the IQueryInterface.
pszIn
[]:
Input string. If this is NULL, EBADPARM is returned. The string contains a comma-delimited list of the MIME types or schemes handled by the specified class.
cls
[]:
AEECLSID of the handler. No validation is performed on this parameter.
Interface
  • ISHELL
Prototype
  •     int ISHELL_RegisterHandler
        (
        IShell * pIShell,
        AEECLSID clsBase,
        const char * pszIn,
        AEECLSID cls
        );
    
Return
  • AEE_SUCCESS : The operation was successful. AEE_EBADCLASS : Invalid ClassID. AEE_EBADPARM : Invalid parameter. AEE_ENOMEMORY : Insufficient memory. AEE_EFAILED : The operation failed. AEE_EALREADY : The handler was already set.
Side Effect
  • None
Comments
Supported handler types: