IVsLibraryMgr.GetCheckAt Method

Article
02/04/2013

Returns the checked state of the requested library.

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

Syntax

'Declaration
Function GetCheckAt ( _
    nLibIndex As UInteger, _
    <OutAttribute> pstate As LIB_CHECKSTATE() _
) As Integer

int GetCheckAt(
    uint nLibIndex,
    LIB_CHECKSTATE[] pstate
)

int GetCheckAt(
    [InAttribute] unsigned int nLibIndex, 
    [OutAttribute] array<LIB_CHECKSTATE>^ pstate
)

abstract GetCheckAt : 
        nLibIndex:uint32 * 
        pstate:LIB_CHECKSTATE[] byref -> int

function GetCheckAt(
    nLibIndex : uint, 
    pstate : LIB_CHECKSTATE[]
) : int

Parameters

nLibIndex
Type: System.UInt32
[in] Specifies the zero-based index of the library of interest.

pstate
Type: array<Microsoft.VisualStudio.Shell.Interop.LIB_CHECKSTATE[]
[out] Specifies the checked state of a library. Values are taken from the LIB_CHECKSTATE enumeration.

Return Value

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

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via