Compartilhar via


IVsLibraryMgr.ToggleCheckAt Method

Tells the requested library to toggle its current checked state.

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

Syntax

'Declaration
Function ToggleCheckAt ( _
    nLibIndex As UInteger _
) As Integer
int ToggleCheckAt(
    uint nLibIndex
)
int ToggleCheckAt(
    [InAttribute] unsigned int nLibIndex
)
abstract ToggleCheckAt : 
        nLibIndex:uint32 -> int
function ToggleCheckAt(
    nLibIndex : uint
) : int

Parameters

  • nLibIndex
    Type: UInt32

    [in] Specifies the zero-based index of the library of interest.

Return Value

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsLibraryMgr::ToggleCheckAt(
   [in] ULONG nLibIndex
);

IVsLibraryMgr.ToggleCheckAt and GetCheckAt are used only if the IVsLibrary in question is not expandable (_LIB_FLAGSLF_EXPANDABLE is not set and GetLibList is not implemented), yet provides a global component for browsing. In such a case, the user sees a check box with the library's display name in the Selected Libraries dialog of the Object Browser. ToggleCheckAt is called as the user selects or un-selects this check box.

Note

The Object Manager persists this checked state across Visual Studio.NET sessions.

.NET Framework Security

See Also

Reference

IVsLibraryMgr Interface

Microsoft.VisualStudio.Shell.Interop Namespace