IOleInPlaceComponent.UseComponentUIManager Method

Informs an in-place object of its role in the environment, providing pointers to the IOleComponentUIManager and IOleInPlaceComponentSite interfaces.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)


Function UseComponentUIManager ( _
    dwCompRole As UInteger, _
    <OutAttribute> ByRef pgrfCompFlags As UInteger, _
    pCompUIMgr As IOleComponentUIManager, _
    pIPCompSite As IOleInPlaceComponentSite _
) As Integer
‘사용 방법
Dim instance As IOleInPlaceComponent
Dim dwCompRole As UInteger
Dim pgrfCompFlags As UInteger
Dim pCompUIMgr As IOleComponentUIManager
Dim pIPCompSite As IOleInPlaceComponentSite
Dim returnValue As Integer

returnValue = instance.UseComponentUIManager(dwCompRole, _
    pgrfCompFlags, pCompUIMgr, pIPCompSite)
int UseComponentUIManager(
    uint dwCompRole,
    out uint pgrfCompFlags,
    IOleComponentUIManager pCompUIMgr,
    IOleInPlaceComponentSite pIPCompSite
int UseComponentUIManager(
    [InAttribute] unsigned int dwCompRole, 
    [OutAttribute] unsigned int% pgrfCompFlags, 
    [InAttribute] IOleComponentUIManager^ pCompUIMgr, 
    [InAttribute] IOleInPlaceComponentSite^ pIPCompSite
abstract UseComponentUIManager : 
        dwCompRole:uint32 * 
        pgrfCompFlags:uint32 byref * 
        pCompUIMgr:IOleComponentUIManager * 
        pIPCompSite:IOleInPlaceComponentSite -> int 
function UseComponentUIManager(
    dwCompRole : uint, 
    pgrfCompFlags : uint, 
    pCompUIMgr : IOleComponentUIManager, 
    pIPCompSite : IOleInPlaceComponentSite
) : int


  • pgrfCompFlags
    Type: System.UInt32%
    [in] Flags specified by the in-place object to control interactions with the environment. For a list of pgrfCompFlags values, see OLECOMPFLAG.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.


COM Signature

From oleipc.idl:

HRESULT IOleInPlaceComponent::UseComponentUIManager(
   [in] DWORD dwCompRole,
   [out] DWORD *pgrfCompFlags,
   [in] IOleComponentUIManager *pCompUIMgr,
   [in] IOleInPlaceComponentSite *pIPCompSite

The environment calls an in-place object's UseComponentUIManager method before the object becomes in-place active. In-place VSPackage objects activate by responding to methods such as DoVerb or UIActivate. UseComponentUIManager directs the in-place object to assume the role specified by the dwCompRole parameter.

In-place objects do not need to call UseComponentUIManager when they re-activate after having deactivated. They only need to call it a single time.

VSPackages typically implement UseComponentUIManager to use the pointer passed in the pCompUIMgr parameter to call QueryInterface and retrieve a pointer to the environment's IOleInPlaceComponentUIManager interface.

.NET Framework Security

See Also


IOleInPlaceComponent Interface

IOleInPlaceComponent Members

Microsoft.VisualStudio.Shell.Interop Namespace