IVsDefaultToolboxTabState.GetDefaultTabExpansion Method

Gets the default state of a given tab.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

'Declaration
Function GetDefaultTabExpansion ( _
    pszTabID As String, _
    <OutAttribute> ByRef pfExpanded As Integer _
) As Integer
'Usage
Dim instance As IVsDefaultToolboxTabState 
Dim pszTabID As String 
Dim pfExpanded As Integer 
Dim returnValue As Integer 

returnValue = instance.GetDefaultTabExpansion(pszTabID, _
    pfExpanded)
int GetDefaultTabExpansion(
    string pszTabID,
    out int pfExpanded
)
int GetDefaultTabExpansion(
    [InAttribute] String^ pszTabID, 
    [OutAttribute] int% pfExpanded
)
function GetDefaultTabExpansion(
    pszTabID : String, 
    pfExpanded : int
) : int

Parameters

  • pszTabID
    Type: System.String

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

  • pfExpanded
    Type: System.Int32%

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

Return Value

Type: System.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.

.NET Framework Security

See Also

Reference

IVsDefaultToolboxTabState Interface

IVsDefaultToolboxTabState Members

Microsoft.VisualStudio.Shell.Interop Namespace