IVsIntelliMouseHandler.LoadBitmap_ Method

Article
2013-03-06

Load the bitmap to display for panning with the Intellisense mouse. Once loaded, you then draw the bitmap with DrawBitmap_.

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

Syntax

'Declaration
Function LoadBitmap_ ( _
    hwnd As IntPtr, _
    idbmp As UInteger, _
    idcur As UInteger, _
    ptOrg As POINT, _
    ByRef lpPanBitmap As UInteger _
) As Integer

int LoadBitmap_(
    IntPtr hwnd,
    uint idbmp,
    uint idcur,
    POINT ptOrg,
    ref uint lpPanBitmap
)

int LoadBitmap_(
    [InAttribute] IntPtr hwnd, 
    [InAttribute] unsigned int idbmp, 
    [InAttribute] unsigned int idcur, 
    [InAttribute] POINT ptOrg, 
    [InAttribute] unsigned int% lpPanBitmap
)

abstract LoadBitmap_ : 
        hwnd:IntPtr * 
        idbmp:uint32 * 
        idcur:uint32 * 
        ptOrg:POINT * 
        lpPanBitmap:uint32 byref -> int

function LoadBitmap_(
    hwnd : IntPtr, 
    idbmp : uint, 
    idcur : uint, 
    ptOrg : POINT, 
    lpPanBitmap : uint
) : int

Parameters

hwnd
Type: System.IntPtr
[in] The HWND of the active window.

idbmp
Type: System.UInt32
[in] The resource ID of the bitmap.

idcur
Type: System.UInt32
[in] The resource ID of the cursor.

ptOrg
Type: Microsoft.VisualStudio.OLE.Interop.POINT
[in] A POINT structure indicating the center point of the bitmap to display.

lpPanBitmap
Type: System.UInt32%
[in] Pointer to a PANBITMAP structure. For more information, see Remarks.

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 vsshell.idl:

HRESULT IVsIntelliMouseHandler::LoadBitmap_(
   [in] HWND hwnd, 
   [in] UINT idbmp, 
   [in] UINT idcur, 
   [in] POINT ptOrg, 
   [in] DWORD* lpPanBitmap
);

PANBITMAP Structure

[C++]

typedef struct tagPANBITMAP
{
   HWND hwnd;
   HDC hdcSrc;
   HBITMAP hbmSave;
   HBITMAP hbmLoaded;
   HBITMAP hbmMask;
   HBITMAP hbmColor;
   int x;
   int y;
   int cx;
   int cy;
} PANBITMAP, FAR *LPPANBITMAP;

.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