CogDatabaseDirectory.Remove Method (String)

CogDatabaseDirectory Remove Method (String)

Cognex VisionPro 9.20

Remove the specified item from the database.

Namespace: Cognex.VisionPro.Database
Assembly: Cognex.VisionPro.Database (in Cognex.VisionPro.Database.dll) Version: 80.0.0.0 (80.0.0.0)

Syntax

public void Remove(
	string key
)

public void Remove(
	string key
)

Public Sub Remove ( 
	key As String
)

Public Sub Remove ( 
	key As String
)

public:
virtual void Remove(
	String^ key
) sealed

public:
virtual void Remove(
	String^ key
) sealed

key: Type: System String
This key specifies the item to remove from the database.

Events

Event Type	Reason
DatabaseRemovingEvent	Fires at the start of a call to this method.
DatabaseRemovedEvent	Fires at the end of a call to this method.
VisionProChangedEvent	Fires when this method changes the values returned by GetCount and GetKeys.

Exceptions

Exception	Condition
ObjectDisposedException	Thrown if this object has already been disposed.
InvalidOperationException	Thrown if not currently connected.
ArgumentNullException	Thrown if the input argument, key, is null.
ArgumentException	Thrown if there is no item in the database with this key.
InvalidOperationException	Thrown if unable to remove record.