IVsUIHierarchyWindow.GetItemState Method

Article
05/06/2010

Returns the state or appearance of the hierarchy.

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

Syntax

'Déclaration
Function GetItemState ( _
    pHier As IVsUIHierarchy, _
    itemid As UInteger, _
    dwStateMask As UInteger, _
    <OutAttribute> ByRef pdwState As UInteger _
) As Integer
'Utilisation
Dim instance As IVsUIHierarchyWindow
Dim pHier As IVsUIHierarchy
Dim itemid As UInteger
Dim dwStateMask As UInteger
Dim pdwState As UInteger
Dim returnValue As Integer

returnValue = instance.GetItemState(pHier, _
    itemid, dwStateMask, pdwState)

int GetItemState(
    IVsUIHierarchy pHier,
    uint itemid,
    uint dwStateMask,
    out uint pdwState
)

int GetItemState(
    [InAttribute] IVsUIHierarchy^ pHier, 
    [InAttribute] unsigned int itemid, 
    [InAttribute] unsigned int dwStateMask, 
    [OutAttribute] unsigned int% pdwState
)

abstract GetItemState : 
        pHier:IVsUIHierarchy * 
        itemid:uint32 * 
        dwStateMask:uint32 * 
        pdwState:uint32 byref -> int

function GetItemState(
    pHier : IVsUIHierarchy, 
    itemid : uint, 
    dwStateMask : uint, 
    pdwState : uint
) : int

Parameters

pHier
Type: Microsoft.VisualStudio.Shell.Interop.IVsUIHierarchy
[in] IVsHierarchy interface to determine the state or appearance of.

itemid
Type: System.UInt32
[in] Identifier of the item in the hierarchy. For a list of itemid values, see VSITEMID.

dwStateMask
Type: System.UInt32
[in] Mask values used to determine which pdwState values are provided. For a list of dwStateMask values, see __VSHIERARCHYITEMSTATE.

pdwState
Type: System.UInt32%
[out, retval] Values taken from the __VSHIERARCHYITEMSTATE enumeration, which were passed in with expf in ExpandItem.

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 IVsUIHierarchyWindow::GetItemState(
   [in] IVsUIHierarchy* pHier,
   [in] VSITEMID itemid,
   [in] VSHIERARCHYITEMSTATE dwStateMask,
   [out, retval] VSHIERARCHYITEMSTATE *pdwState
);

Use this method to determine the state of an item in the hierarchy, such as whether the item is expanded, collapsed, bold, or highlighted. Use the ExpandItem method to set the state of an item in the hierarchy.

.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.

Partager via