IVsUserContext.RemoveAttributeIncludeChildren(String, String) 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.

Removes an attribute or keyword from the context bag and from any associated subcontext bags.

public:
 int RemoveAttributeIncludeChildren(System::String ^ szName, System::String ^ szValue);

public:
 int RemoveAttributeIncludeChildren(Platform::String ^ szName, Platform::String ^ szValue);

int RemoveAttributeIncludeChildren(std::wstring const & szName, std::wstring const & szValue);

public int RemoveAttributeIncludeChildren (string szName, string szValue);

abstract member RemoveAttributeIncludeChildren : string * string -> int

Public Function RemoveAttributeIncludeChildren (szName As String, szValue As String) As Integer

Parameters

szName: String

[in] Attribute name or keyword. If you are removing an attribute, then specify the name of the attribute. If you are removing a lookup keyword or an F1 keyword, then enter the term keyword.

szValue: String

[in] Attribute or keyword value. If you are removing an attribute, then specify the value of the attribute. If you are removing a lookup keyword or F1 keyword, then enter the actual text of the keyword.

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::RemoveAttributeIncludeChildren(  
   [in] LPCOLESTR szName,  
   [in] LPCOLESTR szValue  
);

Calling IVsUserContext.RemoveAttributeIncludeChildren(szName, null) removes all values for a given attribute from the context bag and any associated subcontext bags. Calling IVsUserContext.RemoveAttributeIncludeChildren(null, null) removes all attributes from the context and subcontext bags.

Use the RemoveAttribute method to only remove attributes or keywords from the context bag (that is, excluding the subcontext bag).

Applies to