IVsDefaultToolboxTabState.GetDefaultTabExpansion(String, Int32) 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.12.40391

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.

Gets the default state of a given tab.

public:
 int GetDefaultTabExpansion(System::String ^ pszTabID, [Runtime::InteropServices::Out] int % pfExpanded);

int GetDefaultTabExpansion(std::wstring const & pszTabID, [Runtime::InteropServices::Out] int & pfExpanded);

public int GetDefaultTabExpansion (string pszTabID, out int pfExpanded);

abstract member GetDefaultTabExpansion : string * int -> int

Public Function GetDefaultTabExpansion (pszTabID As String, ByRef pfExpanded As Integer) As Integer

Parameters

pszTabID: String

[In] A pointer to a string containing a unique ID specifying a tab.

pfExpanded: Int32

[out] A Boolean value, true if the tab is expanded.

Returns

Int32

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

Remarks

The tab is specified by unique ID—see IVsToolbox3 for methods for converting names to IDs and back.

If GetDefaultTabExpansion fails, the toolbox sets the tab state according to its own internal logic. Otherwise, the value of pfExpanded determines the setting.

Applies to

Share via