CosDictionary.Remove Method

Docotic.Pdf library help > BitMiracle.Docotic.Pdf > CosDictionary Class > CosDictionary Methods > Remove Method

Removes the value with the specified key from the CosDictionary.

Namespace: BitMiracle.Docotic.Pdf
Assembly: BitMiracle.Docotic.Pdf (in BitMiracle.Docotic.Pdf.dll)

Syntax

public bool Remove(
	string key
)

Public Function Remove ( 
	key As String
) As Boolean

Parameters

key: Type: System.String
The key of the element to remove.

Return Value

Type: Boolean
true if the element is successfully found and removed; otherwise, false.

Exceptions

Exception	Condition
ArgumentNullException	The key or value is null.

Remarks

The key must not be null and should not start with a leading slash. Characters in the key should not be escaped. Empty string (string.Empty) is a valid key.