using System; using System.Drawing; using System.Runtime.InteropServices; using System.Runtime.InteropServices.ComTypes; using Vanara.InteropServices; namespace Vanara.PInvoke { public static partial class Shell32 { ///

/// Called by AutoPlay. Exposes methods that get dynamic information regarding a registered handler prior to displaying it to the user. ///

/// /// /// Prior to this interface, when an application registered a handler and was displayed in the autoplay prompt, the handler was /// always shown as long as the content type (for example, mp3 or avi) associated with that handler was found on the media device. /// The same icon and action string were always displayed. /// /// /// If a handler implements this interface prior to showing the handler, AutoPlay will first call IDynamicHWHandler::GetDynamicInfo /// to determine if this handler is to be presented to the user. If you want to show the handler, you may specify a different action /// string than the one supplied by the static handler registration under HKLM. /// /// // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nn-shobjidl-idynamichwhandler [PInvokeData("shobjidl.h", MSDNShortId = "NN:shobjidl.IDynamicHWHandler")] [ComImport, Guid("DC2601D7-059E-42fc-A09D-2AFD21B6D5F7"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] public interface IDynamicHWHandler { ///

Called by the system to determine whether a particular handler will be shown before the AutoPlay dialog is displayed.

/// /// Type: LPCWSTR /// A pointer to a string that indicates the device path or drive root. /// /// /// Type: DWORD /// The content type. /// /// /// Type: LPWSTR* /// A pointer to the new action string, or NULL if the default action string is to be used. /// /// /// Type: HRESULT /// Returns S_OK if this handler is to be displayed, S_FALSE if it is to be hidden, or an error value otherwise. /// /// /// /// To register a dynamic handler, add a REG_SZ named "DynamicHWHandlerCLSID" and assign it the CLSID of your IDynamicHWHandler implementation. /// /// Example: /// /// HKLMSoftwareMicrosoftWindowsCurrentVersionExplorerAutoplayHandlersHandlersYourHandlerDynamicHWHandlerCLSID /// = [REG_SZ] {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx} /// /// // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nf-shobjidl-idynamichwhandler-getdynamicinfo HRESULT // GetDynamicInfo( LPCWSTR pszDeviceID, DWORD dwContentType, LPWSTR *ppszAction ); [PreserveSig] HRESULT GetDynamicInfo([MarshalAs(UnmanagedType.LPWStr)] string pszDeviceID, uint dwContentType, out StrPtrUni ppszAction); } ///

Called by AutoPlay to implement the handling of registered media types.

/// /// Developers supporting this interface must expose it in a Component Object Model (COM) server. /// /// All applications registered as AutoPlay media handlers must implement this interface. Handlers that implement this interface /// should return quickly from calls to IHWEventHandler::HandleEvent and IHWEventHandler2::HandleEventWithHWND so they won't block /// the AutoPlay dialog from closing. Additionally, if a local server must be launched for the creation of this handler, it should /// not block the CreateInstance call; it should return as soon as possible. /// /// // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nn-shobjidl-ihweventhandler [PInvokeData("shobjidl.h", MSDNShortId = "NN:shobjidl.IHWEventHandler")] [ComImport, Guid("C1FB73D0-EC3A-4ba2-B512-8CDB9187B6D1"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] public interface IHWEventHandler { ///

Initializes an object that contains an implementation of the IHWEventHandler interface.

/// /// Type: LPCWSTR /// A pointer to a string buffer that contains the string from the following registry value. /// /// HKEY_LOCAL_MACHINESoftwareMicrosoftWindowsCurrentVersionExplorerAutoPlayHandlersHandlers /// HandlerName InitCmdLine = string /// /// /// /// Type: HRESULT /// If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. /// /// This method receives the registry string stored in the InitCmdLine value under the // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nf-shobjidl-ihweventhandler-initialize HRESULT Initialize( // LPCWSTR pszParams ); [PreserveSig] HRESULT Initialize([MarshalAs(UnmanagedType.LPWStr)] string pszParams); ///

Handles AutoPlay device events for which there is no content of the type the application is registered to handle.

Not implemented.

/// This parameter is unused. /// This parameter is unused. /// This parameter is unused. /// This parameter is unused. /// This parameter is unused. /// This method does not return a value. // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nf-shobjidl-ihweventhandler-handleeventwithcontent HRESULT // HandleEventWithContent( LPCWSTR pszDeviceID, LPCWSTR pszAltDeviceID, LPCWSTR pszEventType, LPCWSTR pszContentTypeHandler, // IDataObject *pdataobject ); [PreserveSig] HRESULT HandleEventWithContent([MarshalAs(UnmanagedType.LPWStr)] string pszDeviceID, [MarshalAs(UnmanagedType.LPWStr)] string pszAltDeviceID, [MarshalAs(UnmanagedType.LPWStr)] string pszEventType, [MarshalAs(UnmanagedType.LPWStr)] string pszContentTypeHandler, IDataObject pdataobject); } ///

Extends the IHWEventHandler interface to address User Account Control (UAC) elevation for device handlers.

/// /// This interface also provides the methods of the IHWEventHandler interface, from which it inherits. /// /// Handlers that implement this interface should return quickly from calls to IHWEventHandler::HandleEvent and /// IHWEventHandler2::HandleEventWithHWND so they do not block the AutoPlay dialog from closing. Also, if a local server must be /// launched for the creation of this handler, it should not block the CreateInstance call; it should return as soon as possible. /// /// // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nn-shobjidl-ihweventhandler2 [PInvokeData("shobjidl.h", MSDNShortId = "NN:shobjidl.IHWEventHandler2")] [ComImport, Guid("CFCC809F-295D-42e8-9FFC-424B33C487E6"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] public interface IHWEventHandler2 : IHWEventHandler { ///

Initializes an object that contains an implementation of the IHWEventHandler interface.

/// /// Type: LPCWSTR /// A pointer to a string buffer that contains the string from the following registry value. /// /// HKEY_LOCAL_MACHINESoftwareMicrosoftWindowsCurrentVersionExplorerAutoPlayHandlersHandlers /// HandlerName InitCmdLine = string /// /// /// /// Type: HRESULT /// If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. /// /// This method receives the registry string stored in the InitCmdLine value under the // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nf-shobjidl-ihweventhandler-initialize HRESULT Initialize( // LPCWSTR pszParams ); [PreserveSig] new HRESULT Initialize([MarshalAs(UnmanagedType.LPWStr)] string pszParams); ///

Handles AutoPlay device events for which there is no content of the type the application is registered to handle.

Not implemented.

/// This parameter is unused. /// This parameter is unused. /// This parameter is unused. /// This parameter is unused. /// This parameter is unused. /// This method does not return a value. // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nf-shobjidl-ihweventhandler-handleeventwithcontent HRESULT // HandleEventWithContent( LPCWSTR pszDeviceID, LPCWSTR pszAltDeviceID, LPCWSTR pszEventType, LPCWSTR pszContentTypeHandler, // IDataObject *pdataobject ); [PreserveSig] new HRESULT HandleEventWithContent([MarshalAs(UnmanagedType.LPWStr)] string pszDeviceID, [MarshalAs(UnmanagedType.LPWStr)] string pszAltDeviceID, [MarshalAs(UnmanagedType.LPWStr)] string pszEventType, [MarshalAs(UnmanagedType.LPWStr)] string pszContentTypeHandler, IDataObject pdataobject); ///

/// Handles AutoPlay device events that contain content types that the application is not registered to handle. This method /// provides a handle to the owner window so that UI can be displayed if the process requires elevated privileges. ///

/// /// Type: LPCWSTR /// A pointer to a string buffer that contains the device ID. /// /// /// Type: LPCWSTR /// /// A pointer to a string buffer that contains the alternate device ID. The alternate device ID is more human-readable than the /// primary device ID. /// /// /// /// Type: LPCWSTR /// /// A pointer to a string buffer that contains the event type. The event types include DeviceArrival, DeviceRemoval, /// MediaArrival, and MediaRemoval. /// /// /// /// Type: HWND /// A handle to the AutoPlay dialog that was displayed. /// /// /// Type: HRESULT /// If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. /// /// /// /// When a handler is invoked and requires immediate privilege elevation in a new process, it requires an active parent window /// handle to display its consent UI. IHWEventHandler::HandleEvent cannot give a handle, so only a blinking taskbar appears. /// IHWEventHandler2::HandleEventWithHWND provides the HWND and enables the UI to be displayed. /// /// /// Note that if the handler was launched by default instead of by direct user action, the HWND is not active and the dialog is /// not shown in the foreground. /// /// The event types are not C/C++ language constants; they are literal text strings. /// // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nf-shobjidl-ihweventhandler2-handleeventwithhwnd HRESULT // HandleEventWithHWND( LPCWSTR pszDeviceID, LPCWSTR pszAltDeviceID, LPCWSTR pszEventType, HWND hwndOwner ); [PreserveSig] HRESULT HandleEventWithHWND([MarshalAs(UnmanagedType.LPWStr)] string pszDeviceID, [MarshalAs(UnmanagedType.LPWStr)] string pszAltDeviceID, [MarshalAs(UnmanagedType.LPWStr)] string pszEventType, HWND hwndOwner); } ///

/// Exposes a method that programmatically overrides AutoPlay or AutoRun. This allows you to customize the location and type of /// content that is launched when media is inserted. ///

/// /// /// NoteIQueryCancelAutoPlay is intended only for use by user-launched applications that are currently running. It /// should not be handled by invisible or background service applications to prevent the normal AutoPlay/AutoRun feature from being /// invoked. Giving the user a choice of what happens when media and devices are inserted into the system is a key feature of the /// platform. This feature is designed specifically to improve and personalize the user experience and should not be inhibited by /// background services. /// /// /// A valid use of IQueryCancelAutoPlay is illustrated in the following scenario: Assume that you have, through AutoPlay, /// previously designated application A to handle video camera events. For video editing, however, you prefer application B. You /// open application B, begin editing some previously filmed video, and then decide to add some new content to the video being /// edited. Application B's import function prompts you to turn on the video camera so that the new content can be accessed. /// Normally, this video device activation would trigger the launch of the device-associated application A. Fortunately, using /// IQueryCancelAutoPlay, application B has canceled AutoPlay processing of video camera events while you are editing video /// content. In this case, the cancellation of Autoplay by application B has created a better user experience. /// /// // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nn-shobjidl-iquerycancelautoplay [PInvokeData("shobjidl.h", MSDNShortId = "NN:shobjidl.IQueryCancelAutoPlay")] [ComImport, Guid("DDEFE873-6997-4e68-BE26-39B633ADBE12"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] public interface IQueryCancelAutoPlay { [PreserveSig] HRESULT AllowAutoPlay([MarshalAs(UnmanagedType.LPWStr)] string pszPath, uint dwContentType, [MarshalAs(UnmanagedType.LPWStr)] string pszLabel, uint dwSerialNumber); } ///

/// Exposes a method that provides a simple, standard mechanism for objects to query a client for permission to continue an /// operation. Clients of IUserNotification, for example, must pass an implementation of IQueryContinue to the /// IUserNotification::Show method. ///

// https://docs.microsoft.com/en-us/windows/win32/api/shobjidl_core/nn-shobjidl_core-iquerycontinue [PInvokeData("shobjidl_core.h", MSDNShortId = "NN:shobjidl_core.IQueryContinue")] [ComImport, Guid("7307055c-b24a-486b-9f25-163e597a28a9"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] public interface IQueryContinue { ///

Returns S_OK if the operation associated with the current instance of this interface should continue.

/// /// Type: HRESULT /// Returns S_OK if the calling application should continue, S_FALSE if not. /// /// /// In typical usage, a pointer to an IQueryContinue interface is passed to a method of another object. That object, in turn, /// runs this method periodically to determine whether to continue its actions. For example, if a user clicks a cancel button, /// this method will start returning S_FALSE. /// // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl_core/nf-shobjidl_core-iquerycontinue-querycontinue HRESULT QueryContinue(); [PreserveSig] HRESULT QueryContinue(); } ///

/// /// Exposes methods that set notification information and then display that notification to the user in a balloon that appears in /// conjunction with the notification area of the taskbar. /// /// /// NoteIUserNotification2 does not inherit from IUserNotification. IUserNotification2 differs from /// IUserNotification only in its Show method, which adds an additional parameter for a callback interface to communicate /// with the notification. Otherwise the two interfaces are identical in form and function. CLSID_UserNotification implements both /// versions of Show as an overload. /// ///

/// /// When to Implement /// An implementation of this interface is provided in Windows as CLSID_UserNotification. /// // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nn-shobjidl-iusernotification2 [PInvokeData("shobjidl.h", MSDNShortId = "NN:shobjidl.IUserNotification2")] [ComImport, Guid("215913CC-57EB-4FAB-AB5A-E5FA7BEA2A6C"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] public interface IUserNotification2 { ///

Sets the information to be displayed in a balloon notification.

/// /// Type: LPCWSTR /// A pointer to a Unicode string that specifies the title of the notification. /// /// /// Type: LPCWSTR /// A pointer to a Unicode string that specifies the text to be displayed in the body of the balloon. /// /// /// Type: DWORD /// One or more of the following values that indicate an icon to display in the notification balloon. /// NIIF_NONE (0x00000000) /// 0x00000000. Do not display an icon. /// NIIF_INFO (0x00000001) /// 0x00000001. Display an information icon. /// NIIF_WARNING (0x00000002) /// 0x00000002. Display a warning icon. /// NIIF_ERROR (0x00000003) /// 0x00000003. Display an error icon. /// NIIF_USER (0x00000004) /// 0x00000004. Windows XP SP2 and later. Use the icon identified in hIcon in the notification balloon. /// NIIF_NOSOUND (0x00000010) /// /// 0x00000010. Windows XP and later. Do not play the associated sound. This value applies only to balloon notifications /// and not to standard user notifications. /// /// NIIF_LARGE_ICON (0x00000010) /// /// 0x00000010. Windows Vista and later. The large version of the icon should be used as the icon in the notification /// balloon. This corresponds to the icon with dimensions SM_CXICON x SM_CYICON. If this flag is not set, the icon with /// dimensions XM_CXSMICON x SM_CYSMICON is used. /// /// /// /// This flag can be used with all stock icons. /// /// /// /// Applications that use older customized icons (NIIF_USER with hIcon) must provide a new SM_CXICON x SM_CYICON version /// in the tray icon specified in the hIcon member of the NOTIFYICONDATA structure. These icons are scaled down when they /// are displayed in the notification area. /// /// /// /// /// New customized icons (NIIF_USER with hBalloonIcon) must supply an SM_CXICON x SM_CYICON version in the supplied icon /// ( hBalloonIcon). /// /// /// /// NIIF_RESPECT_QUIET_TIME (0x00000080) /// /// 0x00000080. Windows 7 and later. Do not display the notification balloon if the current user is in "quiet time", /// which is the first hour after a new user logs into his or her account for the first time. During this time, most /// notifications should not be sent or shown. This lets a user become accustomed to a new computer system without those /// distractions. Quiet time also occurs for each user after an operating system upgrade or clean installation. A notification /// sent with this flag during quiet time is not queued; it is simply dismissed unshown. The application can resend the /// notification later if it is still valid at that time. /// /// /// Because an application cannot predict when it might encounter quiet time, we recommended that this flag always be set on all /// appropriate notifications by any application that means to honor quiet time. /// /// If the current user is not in quiet time, this flag has no effect. /// NIIF_ICON_MASK (0x0000000F) /// 0x0000000F. Windows XP (Shell32.dll version 6.0 ) and later. Reserved. /// /// /// Type: HRESULT /// If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. /// // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nf-shobjidl-iusernotification2-setballooninfo HRESULT // SetBalloonInfo( LPCWSTR pszTitle, LPCWSTR pszText, DWORD dwInfoFlags ); [PreserveSig] HRESULT SetBalloonInfo([MarshalAs(UnmanagedType.LPWStr)] string pszTitle, [MarshalAs(UnmanagedType.LPWStr)] string pszText, NIIF dwInfoFlags); ///

Specifies the conditions for trying to display user information when the first attempt fails.

/// /// Type: DWORD /// The amount of time, in milliseconds, to display the user information. /// /// /// Type: DWORD /// The interval of time, in milliseconds, between attempts to display the user information. /// /// /// Type: UINT /// The number of times the system should try to display the user information. /// /// /// Type: HRESULT /// If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. /// // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nf-shobjidl-iusernotification2-setballoonretry HRESULT // SetBalloonRetry( DWORD dwShowTime, DWORD dwInterval, UINT cRetryCount ); [PreserveSig] HRESULT SetBalloonRetry(uint dwShowTime, uint dwInterval, uint cRetryCount); ///

Sets the notification area icon associated with specific user information.

/// /// Type: HICON /// A handle to the icon. /// /// /// Type: LPCWSTR /// /// A pointer to a string that contains the tooltip text to display for the specified icon. This value can be NULL, /// although it is not recommended. /// /// /// /// Type: HRESULT /// If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. /// // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nf-shobjidl-iusernotification2-seticoninfo HRESULT SetIconInfo( // HICON hIcon, LPCWSTR pszToolTip ); [PreserveSig] HRESULT SetIconInfo(HICON hIcon, [MarshalAs(UnmanagedType.LPWStr)] string pszToolTip); ///

Displays the user information in a balloon-style tooltip.

/// /// Type: IQueryContinue* /// /// An IQueryContinue interface pointer, used to determine whether the notification display can continue or should stop (for /// example, if the user closes the notification). This value can be NULL. /// /// /// /// Type: DWORD /// The length of time, in milliseconds, to display user information. /// /// /// Type: IUserNotificationCallback* /// /// A pointer to an IUserNotificationCallback interface, used to handle mouse click and hover actions on the notification area /// icon and within the notification itself. This value can be NULL. /// /// /// /// Type: HRESULT /// If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. /// // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nf-shobjidl-iusernotification2-show HRESULT Show( IQueryContinue // *pqc, DWORD dwContinuePollInterval, IUserNotificationCallback *pSink ); HRESULT Show(IQueryContinue pqc, uint dwContinuePollInterval, IUserNotificationCallback pSink); ///

Plays a sound in conjunction with the notification.

/// /// Type: LPCWSTR /// A pointer to a null-terminated Unicode string that specifies the alias of the sound file to play. /// /// /// Type: HRESULT /// If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. /// /// /// /// The string pointed to by pszSoundName contains an alias for a system event found in the registry or the Win.ini file; for /// instance, "SystemExit". /// /// /// The specified sound is played asynchronously and the method returns immediately after beginning the sound. To stop an /// asynchronous waveform sound, call IUserNotification2::PlaySound with pszSoundName set to NULL. /// /// /// The specified sound event will yield to another sound event that is already playing. If a sound cannot be played because the /// resource needed to play that sound is busy, the method immediately returns S_FALSE without playing the requested sound. /// /// If the specified sound cannot be found, IUserNotification2::PlaySound uses the system default sound. /// // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nf-shobjidl-iusernotification2-playsound HRESULT PlaySound( // LPCWSTR pszSoundName ); [PreserveSig] HRESULT PlaySound([MarshalAs(UnmanagedType.LPWStr)] string pszSoundName); } ///

/// Exposes a method for the handling of a mouse click or shortcut menu access in a notification balloon. Used with IUserNotification2::Show. ///

// https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nn-shobjidl-iusernotificationcallback [PInvokeData("shobjidl.h", MSDNShortId = "NN:shobjidl.IUserNotificationCallback")] [ComImport, Guid("19108294-0441-4AFF-8013-FA0A730B0BEA"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] public interface IUserNotificationCallback { ///

/// Called when the user clicks the balloon. The application may respond with an action that is suitable for the balloon being clicked. ///

/// /// Type: POINT* /// /// Takes a pointer to the POINT structure which, upon method return, points to the position of the mouse in screen space where /// the mouse click occurred. /// /// /// /// Type: HRESULT /// If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. /// // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nf-shobjidl-iusernotificationcallback-onballoonuserclick HRESULT // OnBalloonUserClick( POINT *pt ); [PreserveSig] HRESULT OnBalloonUserClick(ref Point pt); ///

/// Called when the user clicks the icon in the notification area. The applications may launch some customary UI in response. ///

/// /// Type: POINT* /// /// Takes a pointer to the POINT structure which, when the method returns, points to the position of the mouse in the screen /// space where the mouse click occurred. /// /// /// /// Type: HRESULT /// If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. /// // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nf-shobjidl-iusernotificationcallback-onleftclick HRESULT // OnLeftClick( POINT *pt ); [PreserveSig] HRESULT OnLeftClick(ref Point pt); ///

/// Called when the user right-clicks (or presses SHIFT+F10) the icon in the notification area. The application should show its /// context menu in response. ///

/// /// Type: POINT* /// /// When returned by the method, takes a pointer to the POINT structure at the position of the mouse in the screen space where /// the click occurred. /// /// In the case where user presses SHIFT+F10, the pointer points to the center of the icon in the screen space. /// /// /// Type: HRESULT /// If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code. /// // https://docs.microsoft.com/en-us/windows/win32/api/shobjidl/nf-shobjidl-iusernotificationcallback-oncontextmenu HRESULT // OnContextMenu( POINT *pt ); [PreserveSig] HRESULT OnContextMenu(ref Point pt); } } }