IVsLibraryMgr.GetCheckAt(UInt32, LIB_CHECKSTATE[]) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

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.

Returns the checked state of the requested library.

public:
 int GetCheckAt(System::UInt32 nLibIndex, cli::array <Microsoft::VisualStudio::Shell::Interop::LIB_CHECKSTATE> ^ pstate);

public:
 int GetCheckAt(unsigned int nLibIndex, Platform::Array <Microsoft::VisualStudio::Shell::Interop::LIB_CHECKSTATE> ^ pstate);

int GetCheckAt(unsigned int nLibIndex, std::Array <Microsoft::VisualStudio::Shell::Interop::LIB_CHECKSTATE> const & pstate);

public int GetCheckAt (uint nLibIndex, Microsoft.VisualStudio.Shell.Interop.LIB_CHECKSTATE[] pstate);

abstract member GetCheckAt : uint32 * Microsoft.VisualStudio.Shell.Interop.LIB_CHECKSTATE[] -> int

Public Function GetCheckAt (nLibIndex As UInteger, pstate As LIB_CHECKSTATE()) As Integer

Parameters

nLibIndex: UInt32

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

pstate: LIB_CHECKSTATE[]

[out] Specifies the checked state of a library. Values are taken from the LIB_CHECKSTATE enumeration.

Returns

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::GetCheckAt(  
   [in] ULONG nLibIndex,  
   [out, retval] LIB_CHECKSTATE *pstate  
);

ToggleCheckAt and IVsLibraryMgr.GetCheckAt are used only if the IVsLibrary in question is not expandable (_LIB_FLAGS LF_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. GetCheckAt is called to get the current checked state of the library.

Note

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

Applies to