IVsUIHierarchyWindow2.SetCursor(IntPtr, IntPtr) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Sets a new cursor for the UI hierarchy window.

public:
 int SetCursor(IntPtr hNewCursor, [Runtime::InteropServices::Out] IntPtr % phOldCursor);

public int SetCursor (IntPtr hNewCursor, out IntPtr phOldCursor);

abstract member SetCursor : nativeint * nativeint -> int

Public Function SetCursor (hNewCursor As IntPtr, ByRef phOldCursor As IntPtr) As Integer

Parameters

hNewCursor: IntPtr
nativeint

[in] New cursor to display in the hierarchy window.

phOldCursor: IntPtr
nativeint

[out, retval] Cursor replaced by the new cursor.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Implements

SetCursor(IntPtr, IntPtr)

Remarks

This method allows you to show a different cursor in the UI hierarchy window when required to indicate specific actions.

To use this method, pass your new cursor into the UI hierarchy window using this method. This method then returns the cursor that you are replacing. Store the old cursor returned by this method and upon completion of the action requiring the new cursor, call this method again, passing in the old cursor through the hNewCursor parameter.

Applies to

Share via