SetIDOfTab Method
Collapse the table of content
Expand the table of content
The document is archived and information here might be outdated

IVsToolbox3.SetIDOfTab Method

Sets the canonical ID for the given Toolbox tab.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in microsoft.visualstudio.shell.interop.8.0.dll)

int SetIDOfTab (
	[InAttribute] string lpszTabName,
	[InAttribute] string lpszTabID
)
int SetIDOfTab (
	/** @attribute InAttribute() */ String lpszTabName, 
	/** @attribute InAttribute() */ String lpszTabID
)
function SetIDOfTab (
	lpszTabName : String, 
	lpszTabID : String
) : int

Parameters

lpszTabName

[in] The localized name of the Toolbox tab.

lpszTabID

[in] The locale-invariant ID of the Toolbox tab.

Return Value

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

COM Signature

From vsshell80.idl:

HRESULT IVsToolbox3::SetIDOfTab(
   [in] LPCOLESTR lpszTabName,
   [in] LPCOLESTR lpszTabID
);

The method sets a canonical ID for the given Toolbox tab. The canonical ID, supplied as lpszTabID, is different from the localizable tab name defined when AddTab is called.

While canonical tab names are required to be unique, localized strings change depending on the locale under which the IDE is running. Therefore, the canonical ID must be locale-invariant.

There are no particular restrictions on the format of the canonical ID string, a GUID might be used, or an easy to remembered string in the language of the developer could be employed.

Any VSPackage that creates a Toolbox tab should call the SetIDOfTab method.

Show:
© 2016 Microsoft