IVsToolWindowFactory.CreateToolWindow(Guid, UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.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.

Enables the environment to create multiple on-demand tool windows that are implemented by VSPackages.

public:
 int CreateToolWindow(Guid % rguidPersistenceSlot, System::UInt32 dwToolWindowId);

public int CreateToolWindow (ref Guid rguidPersistenceSlot, uint dwToolWindowId);

abstract member CreateToolWindow : Guid * uint32 -> int

Public Function CreateToolWindow (ByRef rguidPersistenceSlot As Guid, dwToolWindowId As UInteger) As Integer

Parameters

rguidPersistenceSlot: Guid

[in] Unique identifier of the tool window.

dwToolWindowId: UInt32

[in] Double word containing the tool window ID.

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsToolWindowFactory::CreateToolWindow(  
   [in] REFGUID rguidPersistenceSlot,  
   [in] DWORD dwToolWindowId  
);

When a VSPackage supports multi-instance tool windows, each window uses the same rguidPersistenceSlot. The dwToolWindowId parameter is used to differentiate between the various instances of the tool window. To create the initial instance of the tool window, call CreateToolWindow from your CreateTool implementation with the dwToolWindowId parameter set to zero.

Applies to

Share via