IVsUserContext.RemoveSubcontext Method

Article
2013-02-04

Removes the specified subcontext bag.

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

Syntax

'Declaration
Function RemoveSubcontext ( _
    dwCookie As UInteger _
) As Integer

int RemoveSubcontext(
    uint dwCookie
)

int RemoveSubcontext(
    [InAttribute] unsigned int dwCookie
)

abstract RemoveSubcontext : 
        dwCookie:uint32 -> int

function RemoveSubcontext(
    dwCookie : uint
) : int

Parameters

dwCookie
Type: System.UInt32
[in] Pointer to a unique identifier for the subcontext bag. This is the value returned by the AddSubcontext method when a subcontext bag is linked to the parent context bag.

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 context.idl:

HRESULT IVsUserContext::RemoveSubcontext(
   [in] VSCOOKIE dwcookie
);

The AddSubcontext method returns a pointer to a unique identifier for the subcontext bag. Save this pointer and use it with the IVsUserContext.RemoveSubcontext method to delete the subcontext bag.

.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