using System;
using System.Runtime.InteropServices;
using System.Security;
namespace Vanara.PInvoke
{
public static partial class Shell32
{
///
///
/// Exposes methods that allow implementers of a custom IAssocHandler object to provide access to its explicit Application User Model
/// ID (AppUserModelID). This information is used to determine whether a particular file type can be added to an application's Jump List.
///
///
///
///
/// Only file types for which an application is a registered handler appear in that application's Jump List. When an application uses
/// an explicit AppUserModelID to identify itself and the windows and processes that belong to it, that AppUserModelID must also be
/// set in a handler's implementation so that the handler is recognized as being associated with that application. When the
/// application accesses a file such that SHAddToRecentDocs is called as a result, an attempt is made to add the file to the
/// Recent or Frequent category, or possibly a custom category, in that application's Jump List. If the application is
/// a registered handler for that file type, identified as such by the handler's AppUserModelID matching the application's
/// AppUserModelID, that file is added to the Jump List. If not, it is filtered and does not appear.
///
/// When to Implement
///
/// An implementation of this interface is provided in Windows. Applications that create custom Shell folders that expose an
/// association handler enumeration needed by the system to determine the files allowed in the application's Jump List should
/// implement their own versions.
///
/// When to Use
///
/// This object is needed only if your application is using explicit AppUserModelIDs. Without an explicit AppUserModelID to expose,
/// there is no need for this object.
///
///
/// IObjectWithAppUserModelID is always used as part of a larger object that uses explicit AppUserModelIDs and wants to expose
/// that information to the system.
///
///
/// The system calls the IObjectWithAppUserModelID::GetAppID method implemented on a handler to determine whether the application is
/// a registered handler for a file type.
///
///
// https://docs.microsoft.com/en-us/windows/desktop/api/shobjidl_core/nn-shobjidl_core-iobjectwithappusermodelid
[PInvokeData("shobjidl_core.h", MSDNShortId = "f5b4e6bf-a5bf-49c5-b343-e9c1ec6c263d")]
[SuppressUnmanagedCodeSecurity]
[ComImport, InterfaceType(ComInterfaceType.InterfaceIsIUnknown), Guid("36db0196-9665-46d1-9ba7-d3709eecf9ed")]
public interface IObjectWithAppUserModelId
{
///
/// Specifies a unique application-defined Application User Model ID (AppUserModelID) that identifies the object as a handler for
/// a specific file type. This method is used by applications that require dynamic AppUserModelIDs.
///
///
/// Type: LPCWSTR
/// A pointer to the AppUserModelID string to assign to an application.
///
///
/// Type: HRESULT
///
/// Custom implementations that do not require dynamic AppUserModelIDs can return E_NOTIMPL. Custom implementations that require
/// dynamic AppUserModelIDs should return S_OK if successful, or an error value otherwise.
///
///
// https://docs.microsoft.com/en-us/windows/desktop/api/shobjidl_core/nf-shobjidl_core-iobjectwithappusermodelid-setappid
[PreserveSig]
HRESULT SetAppID([MarshalAs(UnmanagedType.LPWStr)] string pszAppID);
///
/// Retrieves a file type handler's explicit Application User Model ID (AppUserModelID), if one has been declared.
///
///
/// Type: LPWSTR*
/// When this method returns, contains the address of the AppUserModelID string assigned to the object.
///
///
/// Type: HRESULT
/// If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
///
///
///
/// This method can only retrieve an AppUserModelID explicitly set for the handler. If the handler did not register an explicit
/// AppUserModelID and is relying on a system-assigned AppUserModelID, this method will not retrieve the AppUserModelID. For more
/// information, see Application User Model IDs (AppUserModelIDs).
///
///
// https://docs.microsoft.com/en-us/windows/desktop/api/shobjidl_core/nf-shobjidl_core-iobjectwithappusermodelid-getappid
[PreserveSig]
HRESULT GetAppID([MarshalAs(UnmanagedType.LPWStr)] out string ppszAppID);
}
/// Exposes methods that provide access to the ProgID associated with an object.
// https://docs.microsoft.com/en-us/windows/desktop/api/shobjidl_core/nn-shobjidl_core-iobjectwithprogid
[PInvokeData("shobjidl_core.h", MSDNShortId = "3b66ba49-ed39-464e-b15a-c72fdff7f5e5")]
[SuppressUnmanagedCodeSecurity]
[ComImport, InterfaceType(ComInterfaceType.InterfaceIsIUnknown), Guid("71e806fb-8dee-46fc-bf8c-7748a8a1ae13")]
public interface IObjectWithProgId
{
///
/// Sets the ProgID of an object.
///
///
/// Type: LPCWSTR
/// A pointer to a string that contains the new ProgID.
///
///
/// Type: HRESULT
/// If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
///
[PreserveSig]
HRESULT SetProgID([MarshalAs(UnmanagedType.LPWStr)] string pszProgID);
///
/// Retrieves the ProgID associated with an object.
///
///
/// Type: LPWSTR*
/// A pointer to a string that, when this method returns successfully, contains the ProgID.
///
///
/// Type: HRESULT
/// If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
///
[PreserveSig]
HRESULT GetProgID([MarshalAs(UnmanagedType.LPWStr)] out string ppszProgID);
}
///
/// Provides a simple way to support communication between an object and its site in the container.
///
/// Often an object needs to communicate directly with a container site object and, in effect, manage the site object itself. Outside
/// of IOleObject::SetClientSite, there is no generic means through which an object becomes aware of its site. IObjectWithSite
/// provides simple objects with a simple siting mechanism (lighter than IOleObject) This interface should only be used when
/// IOleObject is not already in use.
///
///
/// Through IObjectWithSite, a container can pass the IUnknown pointer of its site to the object through
/// IObjectWithSite::SetSite. Callers can also retrieve the latest site passed to SetSite through IObjectWithSite::GetSite.
/// This latter method is included as a hooking mechanism, allowing a third party to intercept calls from the object to the site.
///
///
// https://docs.microsoft.com/en-us/windows/desktop/api/ocidl/nn-ocidl-iobjectwithsite
[PInvokeData("ocidl.h", MSDNShortId = "e688136e-e06b-46ba-bec9-b8db2f9c468d")]
[ComImport, InterfaceType(ComInterfaceType.InterfaceIsIUnknown), Guid("fc4801a3-2ba9-11cf-a229-00aa003d7352")]
public interface IObjectWithSite
{
///
/// Enables a container to pass an object a pointer to the interface for its site.
///
///
///
/// A pointer to the IUnknown interface pointer of the site managing this object. If NULL, the object should call Release
/// on any existing site at which point the object no longer knows its site.
///
///
///
/// This method returns S_OK on success.
///
///
///
/// The object should hold onto this pointer, calling IUnknown::AddRef in doing so. If the object already has a site, it should
/// call that existing site's IUnknown::Release, save the new site pointer, and call the new site's IUnknown::AddRef.
///
/// E_NOTIMPL is not allowed without implementation of the SetSite method, the IObjectWithSite interface is unnecessary.
///
[PreserveSig]
HRESULT SetSite([In, MarshalAs(UnmanagedType.IUnknown)] object pUnkSite);
///
/// Retrieves the latest site passed using SetSite.
///
///
/// The IID of the interface pointer that should be returned in .
///
///
///
/// Address of pointer variable that receives the interface pointer requested in . Upon successful return, * contains the
/// requested interface pointer to the site last seen in SetSite. The specific interface returned depends on the argument in
/// essence, the two arguments act identically to those in QueryInterface. If the appropriate interface pointer is available, the
/// object must call AddRef on that pointer before returning successfully. If no site is available, or the requested interface is
/// not supported, this method must * to NULL and return a failure code.
///
///
///
/// This method returns S_OK on success. Other possible return values include the following.
///
///
/// Return code
/// Description
///
/// -
/// E_FAIL
/// There is no site, in which case * contains NULL on return.
///
/// -
/// E_NOINTERFACE
/// There is a site, but it does not support the interface requested by .
///
///
///
///
/// E_NOTIMPL is not allowed any object implementing this interface must be able to return the last site seen in IObjectWithSite::SetSite.
///
[PreserveSig]
HRESULT GetSite(in Guid riid, [MarshalAs(UnmanagedType.IUnknown)] out object ppvSite);
}
}
}