Click or drag to resize

LinkarCltDeleteT Method (String, ListT, String, DeleteOptions, String, Int32)

Deletes one or several records in file, in a synchronous way
Persistent Method.

Namespace:  LinkarClient
Assemblies:   LinkarClientMono (in LinkarClientMono.dll) Version: 2.1.0.0 (2.1.0.0)
  LinkarClient (in LinkarClient.dll) Version: 2.1.0.0 (2.1.0.0)
Syntax
public List<T> Delete<T>(
	string filename,
	List<T> records,
	string originalRecords,
	DeleteOptions deleteOptions,
	string customVars = "",
	int receiveTimeout = -1
)

Parameters

filename
Type: SystemString
It's the file name where the records are going to be deleted. DICT in case of deleting a record that belongs to a dictionary.
records
Type: System.Collections.GenericListT
It's the records codes list to be deleted
originalRecords
Type: SystemString
Are the original records separated by Record Separator (30) character, that you want to delete for optimist block checking.
deleteOptions
Type: LinkarCommonDeleteOptions
Object that defines the different Function options: optimisticLockControl, recoverRecordIdType.
customVars (Optional)
Type: SystemString
It's a free text that will travel until the database to make the admin being able to manage additional behaviours in the standard routine SUB.LK.MAIN.CONTROL.CUSTOM. This routine will be called if the argument has content.
receiveTimeout (Optional)
Type: SystemInt32
It's the maximum time in seconds that the client will keep waiting the answer by the server. By default -1 (wait indefinitely).

Type Parameters

T

Exclusive for .NET & Mono

Some functions can accept and return values directly from a class. These classes must contain extra information in their properties to be able to link with the data sent or received. The data dump regarding the classes is made through reflection, record by record. This means that it will take a little longer to process each record.

For this reason, it is not recommended that a great number of records be obtained at once.

This is achieved through the following metadata:

  • MVProperty - This attribute tells the Linkar client that he must try to supply this field with the operations information. The following properties are used to link the feature with its internal value
    • AttributeNumber - Number of the property attribute. It is compulsory to specify this property or the Dictionaryname property.
    • DictionaryName - The name of the property dictionary. It is compulsory to specify this property or AttributeNumber property.
    • InternalType - Data conversions that will be made in the client. None: default value, indicates that the conversion type is not required by the client.
    • InternalDate - The value is saved as an internal date.
    • FormatedDate - The value is saved as a formatted date.
  • MVCalculated - The client must try to supply this calculated field with the operations data. The following properties are used to link the feature with its internal value:
    • DictionaryName - The name of the calculated dictionary. This property is mandatory.
    • InternalType - Data conversions that are made in the client
    • None - Default value, a conversion type is not required by the client.
    • InternalDate - Value is saved as an internal date.
    • FormatedDate - Value is saved as a formatted date.
  • MVList - This is used on list type objects and indicates that the Linkar client must go across to collect their values and complete them. When situated in the main class is understood that it is a multivalue list, in a secondary class, they will be treated as subvalues, and from there to next they will be ignored.

Return Value

Type: ListT
The record's list with the results of the operation.
Exceptions
ExceptionCondition
SocketException

Thrown when there are communication problems between LINKAR Client and LINKAR Server

LkException

Thrown when there are errors in LINKAR Client or LINKAR Server

See Also