StringDictionary.Remove Method (String)

StringDictionary Remove Method (String)

Cognex VisionPro 9.25 SR1

Remove the item with the specified key from this dictionary.

Namespace: Cognex.Vision
Assembly: Cognex.Vision.Core.Net (in Cognex.Vision.Core.Net.dll) Version: 9.25.1.0

Syntax

public override bool Remove(
	string key
)

public override bool Remove(
	string key
)

Public Overrides Function Remove ( 
	key As String
) As Boolean

Public Overrides Function Remove ( 
	key As String
) As Boolean

public:
virtual bool Remove(
	String^ key
) override

public:
virtual bool Remove(
	String^ key
) override

Parameters

key: Type: System String
The key of the item to remove from this dictionary.

Return Value

Type: Boolean

True if a match was found and the item removed, otherwise False.

Implements

IDictionary TKey, TValue Remove(TKey)

Remarks

RemovingItem Raises before the item is removed. RemovedItem Raises after the item is removed.

RemovingItem Raises before the item is removed. RemovedItem Raises after the item is removed. Changed Raises because this method changes the Count and Item properties. The following StateFlags may be affected:

SfCount
SfItem