IVsToolbox3.GetGeneralTabID(String) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Gets the ID for the General tab.

public:
 int GetGeneralTabID([Runtime::InteropServices::Out] System::String ^ % pbstrTabID);

int GetGeneralTabID([Runtime::InteropServices::Out] std::wstring const & & pbstrTabID);

public int GetGeneralTabID (out string pbstrTabID);

abstract member GetGeneralTabID : string -> int

Public Function GetGeneralTabID (ByRef pbstrTabID As String) As Integer

Parameters

pbstrTabID

String

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

Returns

Int32

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

Remarks

GetGeneralTabID returns the unique ID of the General tab, so packages can select that tab without having to hard-code the ID or attempt to look it up in a resource table.

COM Signature

From vsshell80.idl:

HRESULT GetGeneralTabID(  
    [out] BSTR* pbstrTabID  
);