IVsUIShell2::CreateGlyphImageButton Method (IntPtr, UInt16, Int32, Int32, UInt32, IVsImageButton^)

Visual Studio 2015

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

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

Syntax

C++

int CreateGlyphImageButton(
	IntPtr hwnd,
	unsigned short chGlyph,
	int xShift,
	int yShift,
	unsigned int bwiPos,
	[OutAttribute] IVsImageButton^% ppImageButton
)

Parameters

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

chGlyph: Type: System::UInt16
[in] The character representing the glyph to use.

xShift: Type: System::Int32
[in] How far to the right, in logical units, to shift the glyph.

yShift: Type: System::Int32
[in] How far down, in logical units, to shift the glyph.

bwiPos: Type: System::UInt32
[in] A value from the __BWI_IMAGE_POS enumeration specifying how the glyph 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:

C++

HRESULT IVsUIShell2:: CreateGlyphImageButton(
   [in]  HWND             hwnd,
   [in]  WCHAR            chGlyph,
   [in]  int              xShift,
   [in]  int              yShift,
   [in]  BWI_IMAGE_POS    pos,
   [out] IVsImageButton** ppImageButton
);

The glyph is a character from a character set representing a visual symbol such as the close button in a window frame, for example.