IVsPackage.CreateTool(Guid) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

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 on-demand tool windows that are implemented by VSPackages.

public:
 int CreateTool(Guid % rguidPersistenceSlot);

public int CreateTool (ref Guid rguidPersistenceSlot);

abstract member CreateTool : Guid -> int

Public Function CreateTool (ByRef rguidPersistenceSlot As Guid) As Integer

Parameters

rguidPersistenceSlot: Guid

[in] Unique identifier of the Tool window.

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 IVsPackage::CreateTool(  
   [in] REFGUID rguidPersistenceSlot  
);

A tool window can be configured to open automatically the next time the environment is launched if the window was open during the environment shutdown.

This method should not make the Tool window visible; that is, it should not call Show.

To automatically open Tool windows when the environment is launched, pass CTW_fForceCreate to CreateToolWindow. The tool windows and their configuration must be registered in the system registry. For specific registry entry format and values, see Tool Window Registration and Configuration.

Applies to