Compartir a través de


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
int GetDefaultTabExpansion(
    string pszTabID,
    out int pfExpanded
)
int GetDefaultTabExpansion(
    [InAttribute] String^ pszTabID, 
    [OutAttribute] int% pfExpanded
)
abstract GetDefaultTabExpansion : 
        pszTabID:string * 
        pfExpanded:int byref -> int
function GetDefaultTabExpansion(
    pszTabID : String, 
    pfExpanded : int
) : int

Parameters

  • pszTabID
    Type: String

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

  • pfExpanded
    Type: Int32%

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

Return Value

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

Microsoft.VisualStudio.Shell.Interop Namespace