IVsUserContext.RemoveSubcontext(UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Removes the specified subcontext bag.

public:
 int RemoveSubcontext(System::UInt32 dwCookie);

public:
 int RemoveSubcontext(unsigned int dwCookie);

int RemoveSubcontext(unsigned int dwCookie);

public int RemoveSubcontext (uint dwCookie);

abstract member RemoveSubcontext : uint32 -> int

Public Function RemoveSubcontext (dwCookie As UInteger) As Integer

Parameters

dwCookie: UInt32

[in] Pointer to a unique identifier for the subcontext bag. This is the value returned by the AddSubcontext(IVsUserContext, Int32, UInt32) method when a subcontext bag is linked to the parent context bag.

Returns

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.

Applies to