IVsUIShell2.CreateIconImageButton Method

Article
07/12/2014

Creates a mixed image/text button using the specified icon as the image.

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

Syntax

'Declaration
Function CreateIconImageButton ( _
    hwnd As IntPtr, _
    hicon As IntPtr, _
    bwiPos As UInteger, _
    <OutAttribute> ByRef ppImageButton As IVsImageButton _
) As Integer

int CreateIconImageButton(
    IntPtr hwnd,
    IntPtr hicon,
    uint bwiPos,
    out IVsImageButton ppImageButton
)

int CreateIconImageButton(
    [InAttribute] IntPtr hwnd, 
    [InAttribute] IntPtr hicon, 
    [InAttribute] unsigned int bwiPos, 
    [OutAttribute] IVsImageButton^% ppImageButton
)

abstract CreateIconImageButton : 
        hwnd:IntPtr * 
        hicon:IntPtr * 
        bwiPos:uint32 * 
        ppImageButton:IVsImageButton byref -> int

function CreateIconImageButton(
    hwnd : IntPtr, 
    hicon : IntPtr, 
    bwiPos : uint, 
    ppImageButton : IVsImageButton
) : int

Parameters

hwnd
Type: System.IntPtr

[in] Handle to the window that is to own the created button. Currently, Visual Studio ignores this value.

hicon
Type: System.IntPtr

[in] Handle to the icon to be used as the image for the new button.

bwiPos
Type: System.UInt32

[in] A value from the __BWI_IMAGE_POS enumeration specifying how the icon should be positioned in relation to any text in the button.

ppImageButton
Type: Microsoft.VisualStudio.Shell.Interop.IVsImageButton%

[out] Returns an IVsImageButton object representing the new button.

Return Value

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

Remarks

COM Signature

From vsshell80.idl:

HRESULT IVsUIShell2:: CreateGlyphImageButton(
   [in]  HWND              hwnd,
   [in]  HICON             hicon,
   [in]  BWI_IMAGE_POS     pos,
   [out] IVsImageButton**  ppImageButton
);

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via