Deletes the Location from the Tracker database.

Namespace: ININ.IceLib.Tracker
Assembly: ININ.IceLib.Tracker (in ININ.IceLib.Tracker.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public void DeleteLocation(
	string locationId,
	bool deleteIndividuals,
	bool deactivateIfDependencies
)
Visual Basic
Public Sub DeleteLocation ( _
	locationId As String, _
	deleteIndividuals As Boolean, _
	deactivateIfDependencies As Boolean _
)

Parameters

locationId
Type: System..::..String
The ID of the Location.
deleteIndividuals
Type: System..::..Boolean
If set to trueTruetruetrue (True in Visual Basic) delete Individuals.
deactivateIfDependencies
Type: System..::..Boolean
If set to trueTruetruetrue (True in Visual Basic) deactivate if dependencies.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
ININ.IceLib.Connection..::..RequestTimeoutExceptionThe request timed out while waiting for a response.
ININ.IceLib.Connection..::..SessionDisconnectedExceptionThe Session does not have a valid connection.
System..::..ObjectDisposedExceptionThe Session has been disposed.
ININ.IceLib..::..IceLibLicenseExceptionThe client does not have the license required to perform this operation.
ININ.IceLib..::..IceLibExceptionAn error occurred while executing the transaction. See the LastError property of this object's TransactionClient for more information.

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.

See Also