MessagePackObjectDictionary.Remove Method

MessagePackObjectDictionaryRemove Method

Removes the element with the specified key from the MessagePackObjectDictionary.

Namespace: MsgPack
Assembly: MsgPack (in MsgPack.dll) Version: 0.6.0

Syntax

public bool Remove(
	MessagePackObject key
)

Public Function Remove ( 
	key As MessagePackObject
) As Boolean

public:
virtual bool Remove(
	MessagePackObject key
) sealed

abstract Remove : 
        key : MessagePackObject -> bool 
override Remove : 
        key : MessagePackObject -> bool

Parameters

key: Type: MsgPackMessagePackObject
The key of the element to remove.

Return Value

Type: Boolean
true if the element is successfully removed; otherwise, false. This method also returns false if key was not found in the original MessagePackObjectDictionary.

Implements

IDictionaryTKey, TValueRemove(TKey)

Exceptions

Exception	Condition
ArgumentNullException	key is Nil.

Remarks

This method approaches an O(1) operation.

Reference

MessagePackObjectDictionary Class

MsgPack Namespace